API reference @voxolith/renderer/voxInterfaces

VoxModel

One model from a .vox file: its extent, its voxels and the palette they index.

Properties

Property	Type	Description	Defined in
`palette`	`Uint8Array`	256 RGBA entries (1024 bytes). Index by Voxel.c; entry 0 is unused.	vox.ts:40
`size`	`object`	Extent in voxels, Z-up as stored in the file.	vox.ts:37
`size.x`	`number`	-	vox.ts:37
`size.y`	`number`	-	vox.ts:37
`size.z`	`number`	-	vox.ts:37
`voxels`	`Voxel`[]	-	vox.ts:38

VoxMaterial

A MagicaVoxel MATL material for one palette index, as the file states it (the prefix dropped). Fields a file omits take MagicaVoxel's defaults; packMaterials turns these into the renderer's material buffer.

VoxScene

A whole extended .vox file: every model, the scene graph, materials, layers and keyframes, with sample to evaluate the graph at a frame. voxSceneAnimator turns one into a playable Y-up grid.

VoxModel

PropertiesCopy Anchor Link

On this page

Properties