filament/io.github.erkko68.filament/InstanceBuffer

InstanceBuffer

class InstanceBuffer(nativeHandle: NativePointer)

Per-instance local transforms for a renderable drawn with RenderableManager.Builder.instances. Each transform is relative to the renderable's, so moving the renderable moves all its instances. Transforms are column-major mat4fs, 16 floats each. Destroy it with Engine.destroy, after the renderables that use it.

Constructors

InstanceBuffer

constructor(nativeHandle: NativePointer)

Types

Builder

class Builder(instanceCount: Int)

Builds an InstanceBuffer of instanceCount instances, 1 to Engine.maxAutomaticInstances.

Properties

instanceCount

val instanceCount: Int

The instance count given to the Builder.

nativeObject

val nativeObject: NativePointer

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

Functions

getLocalTransform

fun getLocalTransform(index: Int): FloatArray

The local transform of instance index, a mat4f.

setLocalTransforms

fun setLocalTransforms(localTransforms: FloatArray, count: Int = localTransforms.size / 16, offset: Int = 0)

Sets count local transforms (mat4fs in localTransforms), starting at instance offset.