Voxel3DRenderer

Renders volumetric data as a grid of interactive 3D blocks.

Constructor

const renderer = new Voxel3DRenderer(options: Voxel3DRendererOptions);

Options

Property	Type	Default	Description
canvas	HTMLCanvasElement	Required	The target canvas element.
voxelSize	number	1.0	Size of each voxel cube.
threshold	number	0.0	Visibility cutoff (0.0 to 1.0).
opacity	number	0.9	Global transparency.

Methods

setData(data: VoxelData): void

Sets the voxel positions and intensities.

updateThreshold(value: number): void

Updates the GPU threshold immediately. Useful for "peeling" volumetric layers.

updateVoxelSize(size: number): void

Global scale for individual voxels.

Interfaces

VoxelData

interface VoxelData {
  positions: Float32Array; // [x, y, z] centers
  values: Float32Array;    // Intensity [0-1] for each voxel
}

Lighting

Includes a built-in Lambertian lighting model in the fragment shader to provide realistic shading and depth to the volume.

Known limitations

• Bundle entry — pick velo-plot, velo-plot/trading, velo-plot/scientific, or velo-plot/full. See Bundle Architecture.
• WebGPU renderer (renderer: 'webgpu') requires an extended bundle entry and is experimental — use WebGL (default) for production.
• SVG — exportSVG() and renderer: 'svg' require an extended bundle. LaTeX labels and contour overlays are partial; 3D is not supported in SVG. See SVG examples.
• See Plugin status registry for plugin maturity (complete, partial, experimental).