Interface: PNGSequenceOptions

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

Options for a PNG frame-sequence capture.

Properties

fps

fps: number

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

Frames per second to sample the timeline at.

---

from?

optional from: number

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

Start time in seconds. Defaults to 0.

---

onProgress()?

optional onProgress: (progress) => void

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

Progress callback (0-1).

Parameters

progress

number

Returns

void

---

quality?

optional quality: number

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

Quality from 0-1 for lossy types.

---

to?

optional to: number

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

End time in seconds. Defaults to the timeline duration (or 5 if unknown).

---

transparent?

optional transparent: boolean

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

Render with a transparent background, so each 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 opaque frames. Use a lossless type such as 'image/png' to keep the alpha channel.

---

type?

optional type: string

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

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