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

    Interface CaptureRuntime

    What a live capture and HDRI URL resolution need from the running app — attached by the init pipeline once those pieces exist. Without it, scene falls back to the room.

    interface CaptureRuntime {
        sceneRoot: () => Object3D<Object3DEventMap> | null;
        pushCaptureCameraParams: (resolution: number) => void;
        restoreCameraParams: () => void;
        isSettled: () => boolean;
        captureReady?: () => boolean;
        baseUrl: () => string | undefined;
        requestRender?: () => void;
    }
    Index
    sceneRoot pushCaptureCameraParams restoreCameraParams isSettled captureReady? baseUrl requestRender?
    sceneRoot: () => Object3D<Object3DEventMap> | null

    The scene root (LuxarScene), for probe resolution and physical-mesh hiding.

    pushCaptureCameraParams: (resolution: number) => void

    Push the cube camera's params to the material manager (fov 90°, square buffer).

    restoreCameraParams: () => void

    Restore the main camera's params (the ordinary camera-materials push).

    isSettled: () => boolean

    Whether the loader has settled (no update sweep, load pass or LOD load in flight).

    captureReady?: () => boolean

    Whether a live capture can run without delaying worker-pool initialization.

    baseUrl: () => string | undefined

    Base URL of the store, for a store-relative hdri url.

    requestRender?: () => void

    The environment changed outside any frame (an HDRI finished loading): ask for a redraw. Optional — omitted in tests and by embedders that render on their own schedule.

    Settings
    Member Visibility

    On This Page
    Properties