Function: renderJpegImage()
renderJpegImage(
layers,width,height,override?,createCanvas?,maxBytes?):Promise<JpegImage>
Defined in: src/lib/rendering/screenshot/index.ts:101
Flatten all visible layers onto white and encode the result as a JPEG no larger than maxBytes (e.g. an upload
limit): full size at the best quality that fits, otherwise smaller.
Parameters
layers
readonly DrawableLayer[]
width
number
height
number
override?
draw this image instead of one layer's canvas (e.g. a transform in progress)
createCanvas?
CanvasFactory = createOffscreenCanvas
maxBytes?
number = Infinity
the largest file allowed (no limit by default)
Returns
Promise<JpegImage>