flash.display3D.textures.CubeTexture (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

	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
		uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void Uploads a cube texture in Adobe Texture Format (ATF) from a byte array.	CubeTexture
		uploadFromBitmapData(source:BitmapData, side:uint, miplevel:uint = 0):void Uploads a component of a cube map texture from a BitmapData object.	CubeTexture
		uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, side:uint, miplevel:uint = 0):void Uploads a component of a cube map texture from a ByteArray object.	CubeTexture
		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

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
error	Dispatched by the CubeTexture object when an asynchronous texture upload operation fails in some way.	CubeTexture
textureReady	Dispatched by the CubeTexture object when an asynchronous texture upload operation has completed successfully, and the texture can then be used.	CubeTexture

Method detail

uploadCompressedTextureFromByteArray

()

method

public function uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3

Uploads a cube texture in Adobe Texture Format (ATF) from a byte array.

The byte array must contain all faces and mipmaps for the texture.

Parameters

	`data:ByteArray` — a byte array that containing a compressed cube texture including mipmaps. The ByteArray object must use the little endian format.

	`byteArrayOffset:uint` — an optional offset at which to start reading the texture data.

	`async:Boolean` (default = `false`) — If true, this function returns immediately. Any draw method which attempts to use the texture will fail until the upload completes successfully. Upon successful upload, this `CubeTexture` object dispatches `Event.TEXTURE_READY`. Default value: false.

Throws

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

	`ArgumentError` — Texture Decoding Failed: when the compression format of this object cannot be derived from the format of the compressed data in `data`.

	`ArgumentError` — Texture Needs To Be Square: when the decompressed texture does not have equal width and height.

	`ArgumentError` — Texture Size Does Not Match: when the width and height of the decompressed texture do not equal the length of the texture's edge.

	`ArgumentError` — Miplevel Too Large: if the mip level of the decompressed texture is greater than that implied by the length of the texture's edge.

	`ArgumentError` — Texture Format Mismatch: if the decoded ATF bytes don't contain a texture compatible with this texture's format or is not a cube texture.

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

	`RangeError` — Bad Input Size: when there is integer overflow of `byteArrayOffset` or if `byteArrayOffset` + 6 is greater than the length of `data`, or if the number of bytes available from `byteArrayOffset` to the end of the `data` byte array is less than the amount of data required for ATF texture.

See also

flash.events.Event.TEXTURE_READY

uploadFromBitmapData

()

method

public function uploadFromBitmapData(source:BitmapData, side:uint, miplevel:uint = 0):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3

Uploads a component of a cube map texture from a BitmapData object.

This function uploads one mip level of one side of the cube map. Call uploadFromBitmapData() as necessary to upload each mip level and face of the cube map.

Parameters

	`source:BitmapData` — a bitmap.

	`side:uint` — A code indicating which side of the cube to upload: positive X : 0 negative X : 1 positive Y : 2 negative Y : 3 positive Z : 4 negative Z : 5

	`miplevel:uint` (default = `0`) — the mip level to be loaded, level zero being the top-level full-resolution image. The default value is zero.

Throws

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

	`ArgumentError` — Miplevel Too Large: if the specified mip level is greater than that implied by the the texture's dimensions.

	`ArgumentError` — Invalid Cube Side: if `side` is greater than 5.

	`ArgumentError` — Invalid BitmapData Error: if `source` if the BitmapData object does not contain a valid cube texture face. The image must be square, with sides equal to a power of two, and the correct size for the miplevel specified.

	`ArgumentError` — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported.

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

uploadFromByteArray

()

method

public function uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, side:uint, miplevel:uint = 0):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3

Uploads a component of a cube map texture from a ByteArray object.

This function uploads one mip level of one side of the cube map. Call uploadFromByteArray() as neccessary to upload each mip level and face of the cube map.

Parameters

	`data:ByteArray` — a byte array containing the image in the format specified when this CubeTexture object was created. The ByteArray object must use the little endian format.

	`byteArrayOffset:uint` — reading of the byte array starts there.

	`side:uint` — A code indicating which side of the cube to upload: positive X : 0 negative X : 1 positive Y : 2 negative Y : 3 positive Z : 4 negative Z : 5

	`miplevel:uint` (default = `0`) — the mip level to be loaded, level zero is the top-level, full-resolution image.

Throws

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

	`ArgumentError` — Miplevel Too Large: if the specified mip level is greater than that implied by the Texture's dimensions.

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

	`ArgumentError` — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported.

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

Event detail

error

event

Event object type: flash.events.ErrorEvent
ErrorEvent.type property = flash.events.ErrorEvent.ERROR

Language version:

ActionScript 3.0

Runtime version:

AIR 24

Dispatched by the CubeTexture object when an asynchronous texture upload operation fails in some way. The failure code is provided in the errorID field of the error object.

Defines the value of the type property of an error event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`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 object experiencing a network operation failure.
`text`	Text to be displayed as an error message.

textureReady

event

Event object type: flash.events.Event
Event.type property = flash.events.Event.TEXTURE_READY

Language version:

ActionScript 3.0

Runtime version:

AIR 24

Dispatched by the CubeTexture object when an asynchronous texture upload operation has completed successfully, and the texture can then be used.

The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. This event is dispatched by Texture, RectangleTexture and CubeTexture objects to signal the completion of an asynchronous upload. Request an asynchronous upload by using the uploadCompressedTextureFromByteArray() method with a true value for the async argument, or using a method such as uploadFromBitmapDataAsync or uploadFromByteArrayAsync. This event neither bubbles nor is cancelable.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`target`	The texture object that dispatched this event.

Submit Feedback

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

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