filament/io.github.erkko68.filament/IndexBuffer

IndexBuffer

class IndexBuffer(nativeHandle: NativePointer)

A buffer containing vertex indices into a VertexBuffer.

IndexBuffer holds a sequence of indices that reference vertices in an associated VertexBuffer. Indices can be 16-bit (USHORT) or 32-bit (UINT). Typically used in conjunction with RenderableManager to define the geometry of primitives.

Constructors

IndexBuffer

constructor(nativeHandle: NativePointer)

Types

Builder

class Builder

Builder for creating IndexBuffer instances.

IndexType

enum IndexType : Enum<IndexBuffer.IndexType>

Type of the index buffer.

Properties

indexCount

val indexCount: Int

Gets the number of indices in this buffer.

isCreationComplete

val isCreationComplete: Boolean

Returns whether the asynchronous creation of this IndexBuffer has completed; always true when it wasn't built with Builder.async().

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

Functions

setBuffer

fun setBuffer(engine: Engine, data: ByteArray)

Sets the index data for this buffer.

fun setBuffer(engine: Engine, data: ByteArray, destOffsetInBytes: Int, count: Int)

Sets the index data with offset and count.

fun setBuffer(engine: Engine, data: ByteArray, destOffsetInBytes: Int, count: Int, callback: () -> Unit? = null)

Sets the index data with offset, count, and optional completion callback.

setBufferAsync

fun setBufferAsync(engine: Engine, data: ByteArray, destOffsetInBytes: Int = 0, count: Int = 0, callback: (IndexBuffer, AsyncCallStatus) -> Unit? = null): Int

setBuffer, asynchronously: returns an ID for Engine.cancelAsyncCall, and callback runs once on the main thread with how it ended. Needs Engine.isAsynchronousModeEnabled.

IndexBuffer

See also

Constructors

Types

Properties

Functions