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

    Interface LayerSummary

    One row of the Layers panel as the embedder API reports it: the per-layer appearance knobs a remote controller may read and (via LayerPatch) write. Structural / diagnostic fields of the panel's own LayerInfo are deliberately left out; this is the stable subset.

    interface LayerSummary {
        path: string;
        name: string;
        type: LayerType;
        visible: boolean;
        opacity: number;
        gamma: number;
        displayRange: [number, number];
        dataRange: [number, number];
        colormap: string | null;
        supportsColormap: boolean;
        blendingMode: BlendingModeName;
        absorption: number;
        brightness: number;
        authoredBrightness: number;
        amplitudeUnit?: string;
        amplitudeOffset?: number;
        sourceDataRange?: [number, number];
        layerOrder: number | null;
        gain?: number;
    }
    Index
    path name type visible opacity gamma displayRange dataRange colormap supportsColormap blendingMode absorption brightness authoredBrightness amplitudeUnit? amplitudeOffset? sourceDataRange? layerOrder gain?
    path: string

    Scene-graph path — the key setLayer() takes.

    name: string
    type: LayerType
    visible: boolean
    opacity: number
    gamma: number
    displayRange: [number, number]

    Display window [min, max] in data units.

    dataRange: [number, number]

    Authored data bounds the window is clamped into.

    colormap: string | null

    Active colormap name, or null for direct colour.

    supportsColormap: boolean
    blendingMode: BlendingModeName
    absorption: number

    Volumetric absorption κ (meaningful in volumetric blending only).

    brightness: number

    Gsplats display gain (the panel's Brightness, display_gain): rendered brightness per data unit. 1 (and inert) on every other layer type.

    authoredBrightness: number

    The authored display_gain (the opening exposure; 1 when absent). The panel's Brightness readout is brightness / authoredBrightness.

    amplitudeUnit?: string

    Unit of the gsplats amplitudes / display window, when the scene labels it.

    amplitudeOffset?: number

    The level subtracted before fitting (amplitude_offset), when recorded.

    sourceDataRange?: [number, number]

    The source's own intensity span above that level (source_data_range).

    layerOrder: number | null

    Explicit compositing order, or null when inherited/automatic.

    gain?: number

    Live linear gain — present on type === 'sound' layers only.

    Settings
    Member Visibility

    On This Page
    Properties