effect-motion
API ReferencerendererNamespacesRendererFunctions

render

function render(renderer): Effect<void, EffectMotionError | ThreeException>;

Function: render()

function render(renderer): Effect<void, EffectMotionError | ThreeException>;

Defined in: packages/renderer/src/Renderer.ts:433

Draw the current retained scene to the canvas.

Parameters

ParameterType
rendererRenderer

Returns

Effect<void, EffectMotionError | ThreeException>

Remarks

Call after syncFrame. Before drawing, this waits for the async work that sync registered — glyph layouts and image decodes — so a frame never presents half-built text or a missing texture. A failed layout or decode surfaces as a typed error naming the resource.

Nested sub-compositions are drawn to their own render targets first, then the world, then any HUD content composited on top through an identity camera so it ignores camera movement.

With a camera aperture > 0 the world draws through the depth-aware depth-of-field chain (built on first use); at aperture 0 it is never touched. HUD content is drawn after it and stays sharp.

On this page