View source

final class IndexBuffer3D

package openfl.display3D

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

Available on all platforms

IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained by the graphics subsystem.

Indices managed by an IndexBuffer3D object may be used to select vertices from a vertex stream. Indices are 16-bit unsigned integers. The maximum allowable index value is 65535 (0xffff). The graphics subsystem does not retain a reference to vertices provided to this object. Data uploaded to this object may be modified or discarded without affecting the stored values.

IndexBuffer3D cannot be instantiated directly. Create instances by using context3D.createIndexBuffer()

Methods

dispose():Void

Free all native GPU resources associated with this object. No upload() calls on this object will work and using the object in rendering will also fail.

uploadFromByteArray(data:ByteArray, byteArrayOffset:Int, startOffset:Int, count:Int):Void

Store in the graphics subsystem vertex indices.

Parameters:

data

a ByteArray containing index data. Each index is represented by 16-bits (two bytes) in the array. The number of bytes in data should be byteArrayOffset plus two times count.

byteArrayOffset

offset, in bytes, into the data ByteArray from where to start reading.

startOffset

The index in this IndexBuffer3D object of the first index to be loaded in this IndexBuffer3D object. A value for startIndex not equal to zero may be used to load a sub-region of the index data.

count

The number of indices represented by data.

Throws:

TypeError

kNullPointerError when data is null.

RangeError

kBadInputSize when any of count, byteArrayOffset, or startOffset is less than 0, or if byteArrayOffset is greater than or equal to the length of data, or if two times count plus byteArrayOffset is greater than the length of data, or if startOffset + count is greater than numIndices given in context3D.createIndexBuffer().

Error

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

@:value({ byteLength : -1 })uploadFromTypedArray(data:ArrayBufferView, byteLength:Int = -1):Void

Store in the graphics subsystem vertex indices.

Parameters:

data

an ArrayBufferView containing index data. Each index is represented by 16-bits (two bytes) in the array.

byteLength

The number of bytes to read.

uploadFromVector(data:Vector<UInt>, startOffset:Int, count:Int):Void

Store in the graphics subsystem vertex indices.

Parameters:

data

a vector of vertex indices. Only the low 16 bits of each index value are used. The length of the vector must be greater than or equal to count.

startOffset

The index in this IndexBuffer3D object of the first index to be loaded. A value for startOffset not equal to zero may be used to load a sub-region of the index data.

count

The number of indices in data.

Throws:

TypeError

kNullPointerError when data is null.

RangeError

kBadInputSize when count is less than 0 or greater than the length of data, or when startOffset + count is greater than numIndices given in context3D.createIndexBuffer()`.

Error

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