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

    Interface LoaderConfig

    Configuration for data loader behavior

    interface LoaderConfig {
        debug?: boolean;
        onSceneMetadata?: (root: Group) => void;
        enableMonitor?: boolean;
        noCache?: boolean;
        noSliceCache?: boolean;
        noOpfs?: boolean;
        cacheBudgetMB?: number | null;
        cacheDebug?: boolean;
        clearCache?: boolean;
        noPrefetch?: boolean;
        prefetchDebug?: boolean;
    }
    Index
    debug? onSceneMetadata? enableMonitor? noCache? noSliceCache? noOpfs? cacheBudgetMB? cacheDebug? clearCache? noPrefetch? prefetchDebug?
    debug?: boolean

    Enable debug logging

    onSceneMetadata?: (root: Group) => void

    Called once per load with the scene's root group as soon as its root metadata (viewer_config, position_bounds, scene dimensions) is on userData — BEFORE any node loads, and before the root is in the scene. The scene manager frames the opening camera here, so load-time decisions that read the view (partition part gating) see the pose the scene opens on; an embedder's own hook passed through LuxarAppOptions.loaderConfig runs right after that framing.

    enableMonitor?: boolean

    Enable data loading monitor UI

    noCache?: boolean

    Disable ALL cache tiers: SliceCache, L0 decompressed, and L1/L2.

    noSliceCache?: boolean

    Disable only the SliceCache / S-cache (L0/L1/L2 stay on).

    noOpfs?: boolean

    Disable only the L2 OPFS persistent tier (L0/L1/S-cache stay on).

    cacheBudgetMB?: number | null

    Explicit total in-memory cache pool (L0+L1+S-cache) in MB, from ?cacheBudgetMB= / the native launcher. Used where performance.memory is absent (WKWebView/Safari) so heap-aware sizing still gets a real budget.

    cacheDebug?: boolean

    Verbose cache logging.

    clearCache?: boolean

    Clear caches on init.

    noPrefetch?: boolean

    Disable adjacent-chunk prefetching.

    prefetchDebug?: boolean

    Verbose prefetch logging.

    Settings
    Member Visibility

    On This Page
    Properties