splat-transform API Reference - v1.8.0
    Preparing search index...

    Function writeVoxel

    • Voxelizes Gaussian splat data and writes the result as a sparse voxel octree.

      This function performs GPU-accelerated voxelization of Gaussian splat data and outputs two files:

      • filename (.voxel.json) - JSON metadata including bounds, resolution, and array sizes
      • Corresponding .voxel.bin - Binary octree data (nodes + leafData as Uint32 arrays)

      The binary file layout is:

      • Bytes 0 to (nodeCount * 4 - 1): nodes array (Uint32, little-endian)
      • Bytes (nodeCount * 4) to end: leafData array (Uint32, little-endian)

      Parameters

      • options: WriteVoxelOptions

        Options including filename, data, and voxelization settings.

      • fs: FileSystem

        File system for writing output files.

      Returns Promise<void>

      import { writeVoxel, MemoryFileSystem } from '@playcanvas/splat-transform';

      const fs = new MemoryFileSystem();
      await writeVoxel({
      filename: 'scene.voxel.json',
      dataTable: myDataTable,
      voxelResolution: 0.05,
      opacityCutoff: 0.5,
      createDevice: async () => myGraphicsDevice
      }, fs);