Skip to main content

Type Alias: SaveImage()

SaveImage: (extension, size, backgroundColor?) => Promise<void>

Trigger current scene screenshot download. Default extension is .jpg and width in pixels is 3072px. *

Parameters​

extension​

string

Extension to save image with Extension to save image with, default is .jpg *

size​

number

Expected image width in pixels. Height will prevail current canvas ratio. Default is 3072px *

backgroundColor?​

string

Background color for JPEG image. If not value is provided it will use current canvas background *

Returns​

Promise<void>

Fires​

@mimeeq#mimeeq-3d-after-export-image *

Fires​

@mimeeq#mimeeq-3d-before-export-image *