The height of the result data in the target if it is a ByteArray or Vector.<Number> instance. The size of the ByteArray or Vector.<Number> instance is enlarged if necessary and existing data is overwritten.

The progress of a running shader. This property is a value from 0 through 1. Zero is the initial value (0% complete). One indicates that the shader has completed its operation.

If the cancel() method is called this property becomes undefined, and its value cannot be used reliably until the shader operation starts again.

The shader that's used for the operation. Any input or parameter that the shader expects must be provided using the ShaderInput or ShaderParameter property of the Shader instance's data property. An input must be provided using its corresponding ShaderInput even if it is the same as the target object.

To process a ByteArray containing a linear array of data (as opposed to image data) set the corresponding ShaderInput instance's height to 1 and width to the number of 32-bit floating-point values in the ByteArray. In that case, the input in the shader must be defined with the image1 data type.

See also

The object into which the result of the shader operation is written. This object must be a BitmapData, ByteArray, or Vector.<Number> instance.

The width of the result data in the target if it is a ByteArray or Vector.<Number> instance. The size of the ByteArray or Vector.<Number> instance is enlarged if necessary and existing data is overwritten.

Cancels the currently running shader operation. Any result data that is already computed is discarded. The complete event is not dispatched.

Calling cancel() multiple times has no additional effect.

Starts a shader operation in synchronous or asynchronous mode, according to the value of the waitForCompletion parameter.

In asynchronous mode (when waitForCompletion is false), which is the default, the ShaderJob execution runs in the background. The shader operation does not affect the responsiveness of the display or other operations. In asynchronous mode the start() call returns immediately and the program continues with the next line of code. When the asynchronous shader operation finishes, the result is available and the complete event is dispatched.

Only one background ShaderJob operation executes at a time. Shader operations are held in a queue until they execute. If you call the start() method while a shader operation is executing, the additional operation is added to the end of the queue. Later, when its turn comes, it executes.

To execute a shader operation in synchronous mode, call start() with a true value for the waitForCompletion parameter (the only parameter). Your code pauses at the point where start() is called until the shader operation completes. At that point the result is available and execution continues with the next line of code.

When you call the start() method the Shader instance in the shader property is copied internally. The shader operation uses that internal copy, not a reference to the original shader. Any changes made to the shader, such as changing a parameter value, input, or bytecode, are not applied to the copied shader that's used for the shader processing. To incorporate shader changes into the shader processing, call the cancel() method (if necessary) and call the start() method again to restart the shader processing.

While a shader operation is executing, the target object's value is not changed. When the operation finishes (and the complete event is dispatched in asynchronous mode) the entire result is written to the target object at one time. If the target object is a BitmapData instance and its dispose() method is called before the operation finishes, the complete event is still dispatched in asynchronous mode. However, the result data is not written to the BitmapData object because it is in a disposed state.

Dispatched when a ShaderJob that executes asynchronously finishes processing the data using the shader. A ShaderJob instance executes asynchronously when the start() method is called with a false value for the waitForCompletion parameter.

Defines the value of the type property of a complete event object.

This event has the following properties: