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

    Type Alias FileInfo

    Header-only structural metadata for a splat file — the lightweight counterpart to a full read, for validating/inspecting a file (e.g. before upload) without decoding its gaussian data. Reports every LOD level.

    Integrity (truncation/corruption) is enforced by the readers themselves, which throw on a size mismatch — so a returned FileInfo implies a sound file.

    type FileInfo = {
        columns: string[];
        format: InputFormat;
        gaussian: boolean;
        layers: ChunkLayer[];
        lodCounts: number[];
        numGaussians: number;
        numLods: number;
        shBands: SHBands;
    }
    Index
    columns format gaussian layers lodCounts numGaussians numLods shBands
    columns: string[]

    Canonical column names the file exposes.

    format: InputFormat

    Detected input format.

    gaussian: boolean

    Whether the file contains gaussian splat data: the position, geometric (rotation/scale/opacity), and color (DC) layers are all present. false for a readable container that isn't a splat — notably a PLY holding a plain point cloud.

    layers: ChunkLayer[]

    Layers the file exposes, in canonical order.

    lodCounts: number[]

    Per-LOD gaussian counts; lodCounts[0] equals numGaussians.

    numGaussians: number

    Gaussian count of the finest LOD (LOD 0).

    numLods: number

    Number of LOD levels (1 for non-LOD formats).

    shBands: SHBands

    SH band count present in the file.

    Settings
    Member Visibility

    On This Page
    Properties