flash.display3D.textures.RectangleTexture (ActionScript 3.0)

	Property	Defined by
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

	Method		Defined by
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		dispose():void Frees all GPU resources associated with this texture.	TextureBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		uploadFromBitmapData(source:BitmapData):void Uploads a texture from a BitmapData object.	RectangleTexture
		uploadFromBitmapDataAsync(source:BitmapData):void Uploads a texture from a BitmapData object.	RectangleTexture
		uploadFromByteArray(data:ByteArray, byteArrayOffset:uint):void Uploads a texture from a ByteArray.	RectangleTexture
		uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint):void Uploads a texture from a ByteArray.	RectangleTexture
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Event	Summary	Defined by
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Method detail

uploadFromBitmapData

()

method

public function uploadFromBitmapData(source:BitmapData):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3.8

Uploads a texture from a BitmapData object.

Parameters

source:BitmapData — a bitmap.

Throws

	`TypeError` — Null Pointer Error: when `source` is null.

	`ArgumentError` — Invalid BitmapData Error: when `source` does not contain a valid texture. The maximum allowed size in any dimension is 4096 or the size of the backbuffer, whichever is greater.

	`Error` — 3768: The `Stage3D` API may not be used during background execution.

uploadFromBitmapDataAsync

()

method

public function uploadFromBitmapDataAsync(source:BitmapData):void

Language version:

ActionScript 3.0

Runtime version:

AIR 24

Uploads a texture from a BitmapData object.

Parameters

source:BitmapData — a bitmap. This function asynchronously uploads texture data. Any draw method which attempts to use the texture will fail until the upload completes successfully. Upon successful upload, this Texture object dispatches Event.TEXTURE_UPLOADED. Event.TEXTURE_READY is a callback to indicate that the asynchronous call received for the texture object have been executed successfully. Upon any error during the background upload , this Texture object dispatches Event.ERROREVENT.

Throws

	`TypeError` — Null Pointer Error: when `source` is null.

	`ArgumentError` — Invalid BitmapData Error: when `source` does not contain a valid texture. The maximum allowed size in any dimension is 4096 or the size of the backbuffer, whichever is greater.

	`Error` — 3768: The `Stage3D` API may not be used during background execution.

See also

flash.events.Event.TEXTURE_READY

uploadFromByteArray

()

method

public function uploadFromByteArray(data:ByteArray, byteArrayOffset:uint):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3.8

Uploads a texture from a ByteArray.

Parameters

	`data:ByteArray` — a byte array that is contains enough bytes in the textures internal format to fill the texture. rgba textures are read as bytes per texel component (1 or 4). float textures are read as floats per texel component (1 or 4). The ByteArray object must use the little endian format.

	`byteArrayOffset:uint` — the position in the byte array object at which to start reading the texture data.

Throws

	`TypeError` — Null Pointer Error: when `data` is null.

	`RangeError` — Bad Input Size: if the number of bytes available from `byteArrayOffset` to the end of `data` byte array is less than the amount of data required for a texture, or if `byteArrayOffset` is greater than or equal to the length of `data`.

	`Error` — 3768: The `Stage3D` API may not be used during background execution.

uploadFromByteArrayAsync

()

method

public function uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint):void

Language version:

ActionScript 3.0

Runtime version:

AIR 24

Uploads a texture from a ByteArray.

Parameters

	`data:ByteArray` — a byte array that is contains enough bytes in the textures internal format to fill the texture. rgba textures are read as bytes per texel component (1 or 4). float textures are read as floats per texel component (1 or 4). The ByteArray object must use the little endian format.

	`byteArrayOffset:uint` — the position in the byte array object at which to start reading the texture data. This function asynchronously uploads texture data. Any draw method which attempts to use the texture will fail until the upload completes successfully. Upon successful upload, this `Texture` object dispatches `Event.TEXTURE_UPLOADED`. Event.TEXTURE_READY is a callback to indicate that the asynchronous call received for the texture object have been executed successfully. Upon any error during the background upload , this `Texture` object dispatches `Event.ERROREVENT`.

Throws

	`TypeError` — Null Pointer Error: when `data` is null.

	`RangeError` — Bad Input Size: if the number of bytes available from `byteArrayOffset` to the end of `data` byte array is less than the amount of data required for a texture, or if `byteArrayOffset` is greater than or equal to the length of `data`.

	`Error` — 3768: The `Stage3D` API may not be used during background execution.

Submit Feedback

ActionScript 3.0 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendices \| Conventions \| Frames No Frames
Class RectangleTexture	Properties \| Methods \| Events

Package	flash.display3D.textures
Class	public final class RectangleTexture
Inheritance	RectangleTexture TextureBase EventDispatcher Object