flash.events

# ShaderEvent - AS3

Package | flash.events
Class | public class ShaderEvent
Inheritance | ShaderEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A ShaderEvent is dispatched when a shader operation launched from a ShaderJob finishes.

Related API Elements

flash.display.ShaderJob

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bitmapData : BitmapData The BitmapData object that was passed to the ShaderJob.start() method. | ShaderEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | byteArray : ByteArray The ByteArray object that was passed to the ShaderJob.start() method. | ShaderEvent
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event
|  | vector : Vector.<Number> The Vector.<Number> object that was passed to the ShaderJob.start() method. | ShaderEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ShaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bitmap:BitmapData = null, array:ByteArray = null, vector:Vector.<Number> = null) Creates a ShaderEvent object to pass to event listeners. | ShaderEvent
|  | clone():Event [override] Creates a copy of the ShaderEvent object and sets the value of each property to match that of the original. | ShaderEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the ShaderEvent object. | ShaderEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | ShaderEvent

Property Detail

### bitmapData

property

`bitmapData:BitmapData`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The BitmapData object that was passed to the `ShaderJob.start()` method. If a ByteArray or Vector.<Number> was passed to the `start()` method this property is `null`.

Implementation
`public function get bitmapData():BitmapData`
`public function set bitmapData(value:BitmapData):void`

Related API Elements

flash.display.ShaderJob.start()

### byteArray

property

`byteArray:ByteArray`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The ByteArray object that was passed to the `ShaderJob.start()` method. If a BitmapData or Vector.<Number> object was passed to the `start()` method this property is `null`.

Implementation
`public function get byteArray():ByteArray`
`public function set byteArray(value:ByteArray):void`

Related API Elements

flash.display.ShaderJob.start()

### vector

property

`vector:Vector.<Number>`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The Vector.<Number> object that was passed to the `ShaderJob.start()` method. If a BitmapData or ByteArray object was passed to the `start()` method this property is `null`.

Implementation
`public function get vector():Vector.<Number>`
`public function set vector(value:Vector.<Number>):void`

Related API Elements

flash.display.ShaderJob.start()
Constructor Detail

### ShaderEvent

()
Constructor

`public function ShaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bitmap:BitmapData = null, array:ByteArray = null, vector:Vector.<Number> = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Creates a ShaderEvent object to pass to event listeners.

Parameters

| `type:String` — The type of the event, available in the `type` property.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is `false`.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. The default value is `false`.
| `bitmap:BitmapData` (default = `null`)`` — The BitmapData object containing the result of the operation that finished (or `null` if the target wasn't a BitmapData object).
| `array:ByteArray` (default = `null`)`` — The ByteArray object containing the result of the operation that finished (or `null` if the target wasn't a ByteArray object).
| `vector:Vector.<Number>` (default = `null`)`` — The Vector.<Number> instance containing the result of the operation that finished (or `null` if the target wasn't a Vector.<Number> instance).

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Creates a copy of the ShaderEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new ShaderEvent object with property values that match the values of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns a string that contains all the properties of the ShaderEvent object. The string is in the following format:

`[ShaderEvent type=value bubbles=value cancelable=value eventPhase=value bitmapData=value byteArray=value vector=value]`

Returns

| `String` — A string that contains all the properties of the ShaderEvent object.

Constant Detail

### COMPLETE

Constant

`public static const COMPLETE:String = "complete"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`bitmapData` | The BitmapData object containing the result of the operation that finished (or `null` if the target wasn't a BitmapData object).
`byteArray` | The ByteArray object containing the result of the operation that finished (or `null` if the target wasn't a ByteArray object).
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the event object with an event listener.
`target` | The ShaderJob object reporting completion.
`vector` | The Vector.<Number> instance containing the result of the operation that finished (or `null` if the target wasn't a Vector.<Number> instance).

Related API Elements

flash.display.ShaderJob.complete

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00