Homesplat-transform API Reference - v3.10.3
    Preparing search index...

    Type Alias ChunkSourceMetadata

    Static description of a ChunkSource's contents — what's in it and how it's laid out. Populated at open() time; never changes thereafter.

    chunkSize is the gaussian count per chunk; all chunks are this size except the final one in each LOD, which holds lodCounts[lod] % chunkSize gaussians (or chunkSize if the count divides evenly).

    layouts exposes the byte stride and named field map for each available layer, used by callers when acquiring ChunkData buffers from a ChunkDataPool.

    LOD is a structural axis: a chunk belongs to exactly one LOD. Sources never carry a per-gaussian LOD tag.

    type ChunkSourceMetadata = {
        availableLayers: ReadonlySet<ChunkLayer>;
        chunkSize: number;
        comments?: readonly string[];
        extraColumns: readonly ExtraColumn[];
        extras?: unknown;
        layouts: Readonly<Partial<Record<ChunkLayer, LayerLayout>>>;
        lodCounts: readonly number[];
        model: SplatModel;
        numChunks: readonly number[];
        opacityAboveOne?: boolean;
        shBands: SHBands;
        transform: Transform;
    }
    Index
    availableLayers: ReadonlySet<ChunkLayer>

    Which layers the source can serve.

    chunkSize: number

    Gaussians per chunk (all chunks are this size except the last per LOD).

    comments?: readonly string[]

    Free-form producer comments carried by the scene (PLY header comment lines, SOG meta.json / lod-meta.json comments), e.g. Postshot v1.1.69 or postshot.color.eotf=sRGB. Passed through verbatim and written back; ones that describe coordinates are not updated by transforms. Absent when there are none.

    extraColumns: readonly ExtraColumn[]

    Extra non-standard columns mapped to the other layer.

    extras?: unknown

    Application-defined JSON carried by the scene's container (SOG meta.json / lod-meta.json extras, as in glTF). No meaning to splat-transform: read, passed through and written back. Absent when the scene has none.

    Per-layer stride + field map. Keyed by layer; only present for available layers.

    lodCounts: readonly number[]

    Gaussian counts per LOD. lodCounts[0] matches numGaussians.

    model: SplatModel

    How the scene was trained, and so how it must be evaluated.

    numChunks: readonly number[]

    Number of chunks per LOD: Math.ceil(lodCounts[lod] / chunkSize).

    opacityAboveOne?: boolean

    Some gaussian's opacity may exceed 1 (decimated scenes, SOG v3 / PLY opacity_linear input). A hint for writers that must choose their output before seeing the data (the streaming PLY writer writes opacity_linear instead of opacity); absent means no opacity exceeds 1. Combined sources carry it when any input does.

    shBands: SHBands

    SH band count present in the source.

    transform: Transform

    Coordinate-space transform; applied lazily when consumed.