effect-motion
API Reference

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

Where to start

Most scenes only touch a handful of modules:

ModuleFor
SceneDeclaring a scene, creating entities, composing animations
MotionAnimating over a duration, with easing
PhysicsSprings — motion whose length emerges from a simulation
EntityThe shapes, and vec3 for positions
ColorBuilding and adjusting colors
TimingThe easing curves
CameraAiming, orbiting, and dollying the viewpoint
AudioDeclaring 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:api

Re-run it after changing a doc-comment or a public signature.

On this page