View source

final class CubeTexture

package openfl.display3D.textures

extends TextureBase › EventDispatcher

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.events.Event)@:final

Available on all platforms

The CubeTexture class represents a cube texture uploaded to a rendering context.

Defines a cube map texture for use during rendering. Cube mapping is used for many rendering techniques, such as environment maps, skyboxes, and skylight illumination.

You cannot create a CubeTexture object directly; use the Context3D createCubeTexture() instead.

Methods

@:value({ async : false })uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:UInt, async:Bool = false):Void

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

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

byteArrayOffset

an optional offset at which to start reading the texture data.

async

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 Texture 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.

@:value({ generateMipmap : false, miplevel : 0 })uploadFromBitmapData(source:BitmapData, side:UInt, miplevel:UInt = 0, generateMipmap:Bool = false):Void

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

a bitmap.

side

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

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.

@:value({ miplevel : 0 })uploadFromByteArray(data:ByteArray, byteArrayOffset:UInt, side:UInt, miplevel:UInt = 0):Void

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

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

reading of the byte array starts there.

side

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

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.

@:value({ miplevel : 0 })uploadFromTypedArray(data:ArrayBufferView, side:UInt, miplevel:UInt = 0):Void

Uploads a component of a cube map texture from an ArrayBufferView object.

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

Parameters:

data

a typed array containing the image in the format specified when this CubeTexture object was created.

side

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

the mip level to be loaded, level zero is the top-level, full-resolution image.

Inherited Variables

Inherited Methods

Defined by TextureBase

dispose():Void

Frees all GPU resources associated with this texture. After disposal, calling upload() or rendering with this object fails.

Defined by EventDispatcher

@:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeListener(). Then you can register the listener again with the new priority level.

Keep in mind that after the listener is registered, subsequent calls to addEventListener() with a different type or useCapture value result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

If you no longer need an event listener, remove it by calling removeEventListener(), or memory problems could result. Event listeners are not automatically removed from memory because the garbage collector does not remove the listener as long as the dispatching object exists(unless the useWeakReference parameter is set to true).

Copying an EventDispatcher instance does not copy the event listeners attached to it.(If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again(unless registered again for future processing).

Parameters:

type

The type of event.

useCapture

Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.

priority

The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

useWeakReference

Determines whether the reference to the listener is strong or weak. A strong reference(the default) prevents your listener from being garbage-collected. A weak reference does not.

Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL targets only, including html5, cpp, and flash/air. On other targets, this parameter is ignored, and the reference will be strong instead.

Throws:

ArgumentError

The listener specified is not a function.

dispatchEvent(event:Event):Bool

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters:

event

The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns:

A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.

Throws:

Error

The event dispatch recursion limit has been reached.

hasEventListener(type:String):Bool

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type actually triggers an event listener, use willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

When hasEventListener() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type is registered; false otherwise.

@:value({ useCapture : false })removeEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false):Void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters:

type

The type of event.

useCapture

Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.

toString():String

willTrigger(type:String):Bool

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between the hasEventListener() and the willTrigger() methods is that hasEventListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type will be triggered; false otherwise.