filament/io.github.erkko68.filament/EntityManager

EntityManager

class EntityManager(nativeHandle: NativePointer)

Manages entity creation, destruction, and lifecycle.

EntityManager is responsible for allocating and releasing entity IDs, which are opaque 32-bit handles used throughout Filament to refer to scene objects and their components. It is recommended to cache the EntityManager instance.

Thread Safe: All operations on EntityManager are thread-safe.

Constructors

EntityManager

constructor(nativeHandle: NativePointer)

Types

Companion

object Companion

Properties

entityCount

val entityCount: Int

The number of entities currently alive.

latestEpochID

val latestEpochID: Long

The current epoch's ID.

nativeObject

val nativeObject: NativePointer

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

Functions

advanceEpoch

fun advanceEpoch()

Seals the current epoch and starts a new one, recording later destructions there; recycles safe epochs.

create

fun create(): Entity

Create a new Entity.

fun create(entities: IntArray)

Creates entities.size entities into entities. Thread safe.

destroy

fun destroy(e: Entity)

Destroy an entity. The entity ID becomes invalid and should not be used after destruction.

fun destroy(entities: IntArray)

Destroys every entity in entities.

flushNotifications

fun flushNotifications()

Flushes pending entity lifecycle notifications to registered listeners.

isAlive

fun isAlive(e: Entity): Boolean

Check whether an entity is alive (not destroyed).

reclaimSafeEpochs

fun reclaimSafeEpochs()

Recycles the indices of epochs that are safe to reclaim; advanceEpoch already does this, so it is for tests.