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

    Interface ZarrSceneAttrs

    Zarr group attributes for the root scene

    interface ZarrSceneAttrs {
        format_version?: string;
        format_type?: string;
        luxar_software_version?: string;
        luxar_version?: string;
        scene_dimensions?: SceneDimensionAttrs;
        type?: string;
        units?: string;
        position_bounds?: PositionBounds;
        content_hash?: string;
        viewer_config?: ZarrViewerConfig;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Any additional metadata

    Index
    format_version? format_type? luxar_software_version? luxar_version? scene_dimensions? type? units? position_bounds? content_hash? viewer_config?
    format_version?: string

    Scene format version ('0.2' today; scene 0.2+). Checked by data/format-version.ts against SUPPORTED_SCENE_VERSIONS.

    format_type?: string

    Root-header marker identifying the store kind: FORMAT_TYPE_SCENE ('luxar_zarr') for a compiled scene, FORMAT_TYPE_GSPLATS for a detached .gsplats.zarr opened directly.

    luxar_software_version?: string

    Luxar SOFTWARE version (luxar.__version__) that wrote the scene. Provenance only — excluded from content_hash, so it never invalidates a cache.

    luxar_version?: string

    Scene 0.1 LEGACY version key. Read as a fallback when format_version is absent (published 0.1 stores carry only this); never written by a current compiler.

    scene_dimensions?: SceneDimensionAttrs

    Scene-level dimensions

    type?: string

    Scene type identifier

    units?: string

    Physical units

    position_bounds?: PositionBounds

    Scene-level position bounds (union of all node bounds)

    Optionalcontent_hash

    content_hash?: string

    Post-order xxhash64 digest of the whole store (values + storage identity + attrs), stamped at compile time. The OPFS cache validates against it and the scene-identity watchdog baselines on it.

    viewer_config?: ZarrViewerConfig

    Viewer configuration hints from Python API

    Settings
    Member Visibility

    On This Page
    Properties