RenderToImageOptions

Properties

colorSpace?

optional colorSpace?: ColorSpace;

The offscreen surface's colour space. Defaults to 'srgb'.

'display-p3' keeps wide-gamut image and gradient content instead of clamping it, exactly as the <Canvas colorSpace> prop does - and the result carries that space, so drawing it onto a P3 canvas converts rather than reinterprets. Match it to the canvas the image is headed for.

height

height: number;

opaque?

optional opaque?: boolean;

Defaults to false, which leaves everything the scene did not cover transparent.

pixelRatio?

optional pixelRatio?: number;

Pixels per point. Defaults to 1, so the result is exactly width x height pixels - pass the screen's scale for a display-resolution render.

width

width: number;

Logical points, like a <Canvas> of the same size.