SnapshotOptions

Properties

format?

optional format?: SnapshotFormat;

Defaults to 'png'. 'raw' returns straight-alpha RGBA8888 rows.

quality?

optional quality?: number;

1–100, for 'jpeg' and 'webp'. Defaults to 100.

rect?

optional rect?: object;

Crop, in the same logical pixels the scene is drawn in. Defaults to the whole canvas.

height

height: number;

width

width: number;

x

x: number;

y

y: number;

scale?

optional scale?: number;

Multiplier on the cropped region's device-pixel size. Defaults to 1. Must be positive and finite; the ceiling is whatever target the GPU can allocate, so a large canvas times a large scale rejects rather than resolving.