Luxar Viewer API Documentation - v2026.10.19
    Preparing search index...

    Class HdrHeadroomController

    Keeps the HDR headroom right for whatever display the window is on. apply receives every changed resolution (value or provenance).

    Index
    constructor
    events details attaching stopWatchingScreen last disposed apply options
    onChange onScreenSwitch start detect setManual current canMeasure dispose attachScreenDetails doAttachScreenDetails watchCurrentScreen manualKeys geometryKey signals resolve
    events: EventGroup = ...
    details: ScreenDetailsLike | null = null
    attaching: Promise<void> | null = null

    The in-flight getScreenDetails() attach, shared by concurrent callers.

    stopWatchingScreen: (() => void) | null = null
    last: HdrHeadroomResolution | null = null
    disposed: boolean = false
    apply: (r: HdrHeadroomResolution) => void
    options: HdrHeadroomControllerOptions

    • Resolve now, then attach to screen details if the permission is already granted.

      Returns Promise<void>

    • The user moved the slider: remember it for the current display.

      Parameters

      • value: number

      Returns void

    • Attach once; concurrent callers (a double-clicked Detect) share the attempt.

      Returns Promise<void>

    • Keys a hand-set value is stored under: the label key once known, and always the geometry key the synchronous startup resolution reads.

      Returns string[]

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods