effect-motion
API ReferencerendererNamespacesSyncFunctions

syncFrame

function syncFrame(sync, frame): Effect<void, RenderException>;

Function: syncFrame()

function syncFrame(sync, frame): Effect<void, RenderException>;

Defined in: packages/renderer/src/Sync.ts:930

Bring the retained scenes in step with a frame.

Parameters

ParameterType
syncSync
frameAnyFrame

Returns

Effect<void, RenderException>

Remarks

Runs the five phases described in the module overview. Objects are built, updated, or disposed as the frame demands; unchanged ones are skipped by reference equality on their data and equality of their composed transform, so a still scene costs almost nothing to hold.

Scene-graph violations arrive as a typed RenderException naming the offending instance — never as a thrown exception escaping into the caller's Effect.

On this page