API Reference
Generated reference for every public export, across all five packages
Generated from the source's doc-comments — every exported function, type, and constant, with its signature, parameters, and examples.
This is the lookup layer. If you are learning how something works, the concepts pages explain the ideas and examples show them running; come here when you know what you want and need the exact shape of it.
Packages
effect-motion
Scenes, entities, and animators — the core authoring API. Start with Scene, Motion, and Physics.
@effect-motion/renderer
Turning frames into pixels: the browser canvas renderer and the headless Node export path.
@effect-motion/three
The Effect wrapper over three.js the renderer is built on. Scoped resources, typed failures.
@effect-motion/react
The Player component for playing scenes in the browser.
@effect-motion/export
Node-only export: sample frames, render stills and contact sheets, encode videos.
Where to start
Most scenes only touch a handful of modules:
| Module | For |
|---|---|
Scene | Declaring a scene, creating entities, composing animations |
Motion | Animating over a duration, with easing |
Physics | Springs — motion whose length emerges from a simulation |
Entity | The shapes, and vec3 for positions |
Color | Building and adjusting colors |
Timing | The easing curves |
Camera | Aiming, orbiting, and dollying the viewpoint |
Audio | Declaring sounds, controlling playback, and animating gain |
Regenerating
The reference is generated from the TSDoc comments in each package's source and committed, so the docs site builds without running TypeScript:
bun run docs:apiRe-run it after changing a doc-comment or a public signature.