voxolith

RenderOptions

Image size, camera, light and colouring for renderModel; every field is optional.

Defined in: preview/render.ts:16

Properties

PropertyTypeDescriptionDefined in
aimOffset?Vec3Look-at offset in voxels, applied after aimY (for close-ups).preview/render.ts:32
aimY?numberLook-at height as a fraction of the model's height.preview/render.ts:30
ao?booleanDarken voxel faces by their occluded neighbours. Default true.preview/render.ts:38
flat?RGBRender silhouettes in one flat colour, to judge shape alone.preview/render.ts:48
fovDeg?numberVertical field of view in degrees.preview/render.ts:26
ground?booleanDraw a ground plane at the bottom of the model's box, taking its shadow. Default true.preview/render.ts:40
groundColor?[RGB, RGB]The ground plane's two checker colours (8-voxel squares).preview/render.ts:44
height?numberImage height in pixels. Default 560.preview/render.ts:20
palette?RGB[]Replace the model's own role colours.preview/render.ts:46
pitchDeg?numberElevation in degrees above the horizon.preview/render.ts:24
shadows?booleanCast a sun shadow ray per hit. Default true.preview/render.ts:36
sky?[RGB, RGB]Sky gradient, top then horizon.preview/render.ts:42
sun?Vec3Direction towards the sun.preview/render.ts:34
width?numberImage width in pixels. Default 420.preview/render.ts:18
yawDeg?numberOrbit angle in degrees; 0 looks along +Z.preview/render.ts:22
zoom?number>1 pulls the camera back, <1 pushes in.preview/render.ts:28

On this page