render
function render<E, LoaderR>(
Function: render()
function render<E, LoaderR>(
scene,
outPath,
options?): Effect<void,
| EncodeError
| ThreeException
| EffectMotionError
| E,
| ChildProcessSpawner
| FileSystem
| Exclude<LoaderR, SceneInternalR>>;Defined in: packages/export/src/Video.ts:98
Render a scene to a video file at outPath.
Fails with Ffmpeg.EncodeError on odd output dimensions (invalid for
yuv420p) — before any ffmpeg process is spawned — or on an ffmpeg failure;
a GPU render failure surfaces as ThreeException; a failed resource
(font layout, image decode) as EffectMotionError.
Type Parameters
| Type Parameter | Default type |
|---|---|
E | never |
LoaderR | never |
Parameters
| Parameter | Type |
|---|---|
scene | Scene<E, LoaderR | SceneInternalR> |
outPath | string |
options | VideoOptions |
Returns
Effect<void,
| EncodeError
| ThreeException
| EffectMotionError
| E,
| ChildProcessSpawner
| FileSystem
| Exclude<LoaderR, SceneInternalR>>