Skip to main content

Interface: FrameExportOptions

Defined in: src/export/FrameExporter.ts:35

Options for a single-frame PNG capture.

Properties​

quality?​

optional quality: number

Defined in: src/export/FrameExporter.ts:41

Quality from 0-1 for lossy types such as 'image/jpeg'. Ignored for PNG.

time?​

optional time: number

Defined in: src/export/FrameExporter.ts:37

Timeline time in seconds to seek to before capture. Omit for current frame.

transparent?​

optional transparent: boolean

Defined in: src/export/FrameExporter.ts:49

Render with a transparent background, so the PNG carries a real alpha channel (RGBA, transparent where nothing is drawn). Defaults to false. Needs a Scene created with { alpha: true } (or backgroundOpacity < 1); otherwise the export throws a clear error instead of producing an opaque image. Use a lossless type such as 'image/png' to keep the alpha channel.

type?​

optional type: string

Defined in: src/export/FrameExporter.ts:39

Image MIME type. Defaults to 'image/png'.