Class DumpTools
Hierarchy
- DumpTools
Index
Constructors
Methods
Constructors
constructor
Returns DumpTools
Methods
Static DisposeSearch playground for Dispose
Dispose the dump tools associated resources
Returns void
Static Dump
Dumps an array buffer
Parameters
width: number
defines the rendering width
height: number
defines the rendering height
data: ArrayBufferView
the data array
Optional successCallback: ((data: string | ArrayBuffer) => void)
defines the callback triggered once the data are available
Parameters
data: string | ArrayBuffer
Returns void
Optional mimeType: string
defines the mime type of the result
Optional fileName: string
defines the filename to download. If present, the result will automatically be downloaded
Optional invertY: boolean
true to invert the picture in the Y dimension
Optional toArrayBuffer: boolean
true to convert the data to an ArrayBuffer (encoded as
mimeType) instead of a base64 stringOptional quality: number
The quality of the image if lossy mimeType is used (e.g. image/jpeg, image/webp). See HTMLCanvasElement.toBlob()'s
qualityparameter.
Returns void
Static Dump
Dumps an array buffer
Parameters
width: number
defines the rendering width
height: number
defines the rendering height
data: ArrayBufferView
the data array
Optional mimeType: string
defines the mime type of the result
Optional fileName: string
defines the filename to download. If present, the result will automatically be downloaded
Optional invertY: boolean
true to invert the picture in the Y dimension
Optional toArrayBuffer: boolean
true to convert the data to an ArrayBuffer (encoded as
mimeType) instead of a base64 stringOptional quality: number
The quality of the image if lossy mimeType is used (e.g. image/jpeg, image/webp). See HTMLCanvasElement.toBlob()'s
qualityparameter.
Returns Promise<string | ArrayBuffer>
a promise that resolve to the final data
Static Dump
Dumps the current bound framebuffer
Parameters
width: number
defines the rendering width
height: number
defines the rendering height
engine: Engine
defines the hosting engine
Optional successCallback: ((data: string) => void)
defines the callback triggered once the data are available
Parameters
data: string
Returns void
Optional mimeType: string
defines the mime type of the result
Optional fileName: string
defines the filename to download. If present, the result will automatically be downloaded
Optional quality: number
The quality of the image if lossy mimeType is used (e.g. image/jpeg, image/webp). See HTMLCanvasElement.toBlob()'s
qualityparameter.
Returns Promise<void>
a void promise
Class containing a set of static utilities functions to dump data from a canvas