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

    Class GSplatResourceBase

    Base class for Gaussian splat resources, with the properties all of them share. The resource of a loaded gsplat Asset is one of its subclasses, except for streamed level-of-detail data, which uses GSplatOctreeResource. GSplatContainer creates one procedurally.

    Hierarchy (View Summary)

    Index
    _centers: Float32Array<ArrayBufferLike> | null
    _format: GSplatFormat = null

    Format descriptor for this resource. Assigned by derived classes.

    • 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. Loaded resources set this from the file, when it records the training mode: the antialiased 1 or SplatRenderMode: mip PLY header comment, the model field of a SOG file, or the anti-aliased flag of an SPZ file. 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 splat file, as in glTF's extras: the extras value of a SOG's meta.json. The engine attaches no meaning to it. Undefined when the file has none, and for formats that cannot carry it.

      Returns any

    • Protected

      Actually destroys this resource and releases all GPU resources. Derived classes should override this method instead of destroy().

      Returns void

    • Destroys this resource. If the resource is still in use by the sorter, destruction is automatically deferred until it's safe.

      Returns void