Takes a snapshot of the whole of this Render Texture.
The snapshot is taken immediately.
To capture just a portion of the Render Texture see the snapshotArea method. To capture a specific pixel, see snapshotPixel.
Snapshots work by using the WebGL readPixels feature to grab every pixel from the frame buffer into an ArrayBufferView.
It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it,
which is the image returned to the callback provided. All in all, this is a computationally expensive and blocking process,
which gets more expensive the larger the canvas size gets, so please be careful how you employ this in your game.
| name | type | arguments | Default | description |
|---|---|---|---|---|
| callback | Phaser.Types.Renderer.Snapshot.SnapshotCallback |
The Function to invoke after the snapshot image is created. |
||
| type | string | <optional> | 'image/png' |
The format of the image to create, usually |
| encoderOptions | number | <optional> | 0.92 |
The image quality, between 0 and 1. Used for image formats with lossy compression, such as |
This Render Texture instance.