filament/io.github.erkko68.filament/BufferObject

BufferObject

class BufferObject(nativeHandle: NativePointer)

A generic GPU buffer for storing data.

BufferObject usage is optional and mainly useful when you need to share data between multiple VertexBuffer instances. It also allows you to efficiently swap-out buffers in VertexBuffer.

For simple use cases where you don't need to share data, it is not necessary to use BufferObject. The buffer is created uninitialized; use setBuffer() to initialize it.

See also

, IndexBuffer

Constructors

constructor(nativeHandle: NativePointer)

Types

enum BindingType : Enum<BufferObject.BindingType>

Binding type options for BufferObject.

Builder for creating BufferObject instances.

Properties

val byteCount: Int

Gets the size of this BufferObject in bytes.

val nativeObject: NativePointer

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

Functions

fun setBuffer(engine: Engine, data: ByteArray)

Asynchronously copies data to initialize a region of this BufferObject.

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

Asynchronously copies data to a region of this BufferObject with offset and count.

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

Asynchronously copies data to a region of this BufferObject with callback.