Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...
    Index
    roomTarget: { texture: Texture; dispose(): void } | null = null
    captureTarget: CubeTargetLike | null = null
    bakedTexture: CubeTexture<unknown> | null = null
    hdriTexture: Texture<unknown, TextureEventMap> | null = null
    hdriLoading: string | null = null
    config: EnvironmentConfig = DEFAULT_ENVIRONMENT_CONFIG
    baked: BakedEnvironment | null = null
    runtime: CaptureRuntime | null = null
    captureProbeSpec: string | null = null
    wanted: boolean = false

    Set by the first ensure() — a physical material exists, so the scene needs light.

    active: EnvironmentKind = 'none'
    staleSince: number | null = null
    captureCount: number = 0

    How many live captures have run (a diagnostic the tests and the bake read).

    • A physical material now exists: make sure the scene is lit.

      Idempotent — every call after the first that changes nothing returns false. Synchronous for the room and a live capture, so a physical mesh created this frame is lit on its first draw.

      Returns boolean

      true when this call built or replaced the environment.

    • Something the capture depends on changed (a commit, a slice, an appearance edit). Only meaningful while lit by a live scene capture; the next tick after the debounce, with the loader settled, re-captures.

      Returns void

    • Per-frame hook (the init pipeline registers it). Re-captures a stale live environment once the debounce has passed and the loader is settled. Returns whether a capture ran.

      Parameters

      • now: number = ...

      Returns boolean