effect-motion
API ReferencerendererNamespacesRendererInterfaces

MakeOptions

readonly optional canvas?: HTMLCanvasElement;

Interface: MakeOptions

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

Properties

canvas?

readonly optional canvas?: HTMLCanvasElement;

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

Canvas to draw into; one is created if omitted.


dofQuality?

readonly optional dofQuality?: DofQuality;

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

Depth-of-field sample quality. "realtime" halves the blur's gather taps, about half the blur's GPU time, for a little more sample noise; pass "full" for export-quality blur (what the Node renderer always uses) when frame rate does not matter, e.g. recording the canvas.

Default Value

"realtime"


height

readonly height: number;

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

Logical height in CSS pixels.


pixelRatio?

readonly optional pixelRatio?: number;

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

Device pixels per logical pixel — pass window.devicePixelRatio for a sharp result on a high-DPI display.

Default Value

1


renderers?

readonly optional renderers?: Record<string, AnyEntityRenderer>;

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

Renderers for custom entity kinds, or overrides for built-in ones. Merged over the built-in manifest by entity tag.


width

readonly width: number;

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

Logical width in CSS pixels.

On this page