Drag[en]gine Script Module DragonScript Script API 1.0
Capture canvas. More...
|Create capture canvas. More...|
|Canvas view to capture. More...|
|void||setCanvas (Canvas canvasView)|
|Set canvas view to capture. More...|
|Image to capture canvas view into. More...|
|void||setImage (int width, int height, int componentCount, int bitCount)|
|Set image to capture canvas view into. More...|
|Drop image if set. More...|
|Capture in progress. More...|
|void||setCapture (bool capture)|
|Set if capture is in progress. More...|
|bool||equals (Object other)|
|Capture canvas is equal to another object. More...|
|Hash code for use as dictionary keys. More...|
Capture canvas allows to capture the rendering result of a canvas view into an deImage resource. Capturing is done by the graphic module during the next frame rendering. During the next GraphicSystem.renderWindows() call or at the end of the current GraphicSystem.renderWindows() call the result is stored back into the capture canvas. Whichever is the case depends on the rendering method of the graphic module. You know when the result is ready capture is set to false. The image resource is created by the caller and allows to request the result in a specific size and format. To do a successful capturing of a render view you have to do the following:
Drop image if set.
Capture canvas is equal to another object.
Canvas view to capture.
Capture in progress.
Image to capture canvas view into.
Hash code for use as dictionary keys.
Create capture canvas.
Set canvas view to capture.
|EInvalidParam||canvasView is not of type Canvas.VIEW.|
Set if capture is in progress.
Set image to capture canvas view into.
Creates a new image with the requested parameters.
|EInvalidParam||width is less than 1.|
|EInvalidParam||height is less than 1.|
|EInvalidParam||componentCount is not 1, 2, 3 or 4.|
|EInvalidParam||bitCount is not 8 or 24.|