filament/io.github.erkko68.filament/Scene

Scene

class Scene(nativeHandle: NativePointer)

A Scene is a collection of Renderables and Lights to be rendered together.

A Scene must be associated with a View to be rendered. Renderables, Lights, Skyboxes, and IndirectLight can be added to and removed from a Scene. Scenes are relatively lightweight objects that mainly manage entity membership.

Constructors

Scene

constructor(nativeHandle: NativePointer)

Properties

entityCount

val entityCount: Int

Gets the number of entities in this scene.

indirectLight

var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

lightCount

val lightCount: Int

Gets the number of light entities in this scene.

nativeObject

val nativeObject: NativePointer

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

renderableCount

val renderableCount: Int

Gets the number of renderable entities in this scene.

skybox

var skybox: Skybox?

Sets the skybox for this scene.

Functions

addEntities

fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

addEntity

fun addEntity(entity: Entity)

Adds a single entity to this scene.

forEach

fun forEach(functor: (Entity) -> Unit)

Invokes functor on every entity in this scene.

hasEntity

fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

remove

fun remove(entity: Entity)

Removes a single entity from this scene.

removeAllEntities

fun removeAllEntities()

Removes all Renderables and Lights from this scene.

removeEntities

fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

Scene

See also

Constructors

Properties

Functions