Splats · interface

SplatCaptureOptions

Explained in Gaussian splats.

interface SplatCaptureOptions
import type { SplatCaptureOptions } from '@driftengine/splats';

Properties

NameTypeDescription
totalreadonlynumberSplats in the whole capture. Every array is allocated for this and never grows.
boundsMinreadonlyArrayLike<number>The whole capture's extent, which a .drft block carries in its own header.
boundsMaxreadonlyArrayLike<number>
sphericalHarmonicsreadonlyoptionalnumberCoefficients the source carried, of which the shader reads the first band. Recorded.
wordsPerSplatreadonlyoptionalnumberWords in one record, from the block's own header.
More

Taken from the file rather than assumed, which is what FORMAT.md §4.7 designed the field for: a capture with degree-1 view-dependent colour writes twelve where one without writes eight, and a streaming reader that hard-coded the width would read the second block's records at the wrong offset and draw a cloud of noise. Defaults to SPLAT_WORDS so a caller with no container behind it is unaffected.