Engine API Reference - v2.24.0-beta.33
    Preparing search index...

    Class GSplatOctreeResource

    A Gaussian splat resource for streamed level-of-detail data, created when loading a lod-meta.json or .lcc2 file. Its splats are loaded in chunks on demand, based on the view distance and the splat budget.

    Index
    data: any

    Raw parsed manifest data, retained for consumers that read custom or extension fields the octree itself does not consume (for example application-specific metadata accompanying a lod-meta.json). Its tree field is null, as the node hierarchy is consumed when the resource is created.

    • get antiAlias(): boolean

      Gets whether the splats were trained with anti-aliasing.

      Returns boolean

    • set antiAlias(value: boolean): void

      Sets whether the splats were trained with anti-aliasing (a screen-space filter with opacity compensation, as in Mip-Splatting), which they need to be rendered with to look right. Set from the model field of the lod-meta.json file when it records the training mode, and applies to all the files the splats are streamed from. Set it for files that do not record the training mode. Used when GSplatParams#antiAlias is undefined, its default. Defaults to false.

      Parameters

      • value: boolean

      Returns void

    • get extras(): any

      Application-defined data stored with the streamed splat scene, as in glTF's extras: the extras value of its lod-meta.json. The engine attaches no meaning to it. Undefined when the manifest has none.

      Returns any

    • get numSplats(): number

      Total number of splats across all leaf nodes at the highest LOD (LOD 0) — the full-detail splat count of the captured scene. Not all of these are resident at runtime: the LOD streaming system selects a subset per node based on view distance and the configured splat budget.

      Returns number