voxolith
API reference@voxolith/gen-kit@voxolith/gen-kit/previewFunctions

drawText()

Draw text into an RGB buffer. Unknown characters render as blank.

function drawText(
   rgb: Uint8Array, 
   bufW: number, 
   bufH: number, 
   x0: number, 
   y0: number, 
   text: string, 
   color: [number, number, number], 
   scale?: number
): void;

Defined in: preview/font.ts:29

Parameters

ParameterTypeDefault value
rgbUint8Arrayundefined
bufWnumberundefined
bufHnumberundefined
x0numberundefined
y0numberundefined
textstringundefined
color[number, number, number]undefined
scale?number2

Returns

void

cutAway()

A copy of a dense model with everything on one side of an axis plane removed, to show its inside. Voxels exactly at at are kept. Sparse models (finer scales) are not supported: they have no dense data.

encodePng()

Encode 8-bit RGB pixels, row-major, as a PNG file (no alpha, no filtering). Uses node:zlib.

On this page

ParametersReturns