Skip to main content

XR8.CanvasScreenshot.configure()

XR8.CanvasScreenshot.configure({ maxDimension, jpgCompression })

Description

Configures the expected result of canvas screenshots.

Parameters

ParameterDefaultDescription
maxDimension: [Optional]1280The value of the largest expected dimension.
jpgCompression: [Optional]751-100 value representing the JPEG compression quality. 100 is little to no loss, and 1 is a very low quality image.

Returns

None

Example

XR8.CanvasScreenshot.configure({ maxDimension: 640, jpgCompression: 50 })