filament/io.github.erkko68.filament/Scene

Scene

actual class Scene

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.

See also

, Renderer, RenderableManager, LightManager

expect class Scene

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.

See also

, Renderer, RenderableManager, LightManager

actual class Scene(jsScene: Scene)

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.

See also

, Renderer, RenderableManager, LightManager

actual class Scene

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.

See also

, Renderer, RenderableManager, LightManager

actual class Scene

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.

See also

, Renderer, RenderableManager, LightManager

Constructors

Link copied to clipboard
constructor(jsScene: Scene)

Properties

Link copied to clipboard
actual val entityCount: Int

Gets the number of entities in this scene.

expect val entityCount: Int

Gets the number of entities in this scene.

actual val entityCount: Int

Gets the number of entities in this scene.

actual val entityCount: Int

Gets the number of entities in this scene.

actual val entityCount: Int

Gets the number of entities in this scene.

Link copied to clipboard
actual var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

expect var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

actual var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

actual var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

actual var indirectLight: IndirectLight?

Sets the indirect light (IBL) for this scene.

Link copied to clipboard
actual val lightCount: Int

Gets the number of light entities in this scene.

expect val lightCount: Int

Gets the number of light entities in this scene.

actual val lightCount: Int

Gets the number of light entities in this scene.

actual val lightCount: Int

Gets the number of light entities in this scene.

actual val lightCount: Int

Gets the number of light entities in this scene.

Link copied to clipboard
val nativeScene: Scene
Link copied to clipboard
actual val renderableCount: Int

Gets the number of renderable entities in this scene.

expect val renderableCount: Int

Gets the number of renderable entities in this scene.

actual val renderableCount: Int

Gets the number of renderable entities in this scene.

actual val renderableCount: Int

Gets the number of renderable entities in this scene.

actual val renderableCount: Int

Gets the number of renderable entities in this scene.

Link copied to clipboard
actual var skybox: Skybox?

Sets the skybox for this scene.

expect var skybox: Skybox?

Sets the skybox for this scene.

actual var skybox: Skybox?

Sets the skybox for this scene.

actual var skybox: Skybox?

Sets the skybox for this scene.

actual var skybox: Skybox?

Sets the skybox for this scene.

Functions

Link copied to clipboard
actual fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

expect fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

actual fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

actual fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

actual fun addEntities(entities: IntArray)

Adds multiple entities to this scene.

Link copied to clipboard
actual fun addEntity(entity: Entity)

Adds a single entity to this scene.

expect fun addEntity(entity: Entity)

Adds a single entity to this scene.

actual fun addEntity(entity: Entity)

Adds a single entity to this scene.

actual fun addEntity(entity: Entity)

Adds a single entity to this scene.

actual fun addEntity(entity: Entity)

Adds a single entity to this scene.

Link copied to clipboard
actual fun forEach(block: (Entity) -> Unit)

Iterates over all entities in this scene.

expect fun forEach(block: (Entity) -> Unit)

Iterates over all entities in this scene.

actual fun forEach(block: (Entity) -> Unit)

Iterates over all entities in this scene.

actual fun forEach(block: (Entity) -> Unit)

Iterates over all entities in this scene.

actual fun forEach(block: (Entity) -> Unit)

Iterates over all entities in this scene.

Link copied to clipboard
actual fun getEntities(): IntArray

Gets all entities in this scene.

actual fun getEntities(outArray: IntArray?): IntArray

Gets all entities in this scene, optionally reusing an output array.

expect fun getEntities(): IntArray

Gets all entities in this scene.

expect fun getEntities(outArray: IntArray?): IntArray

Gets all entities in this scene, optionally reusing an output array.

actual fun getEntities(): IntArray

Gets all entities in this scene.

actual fun getEntities(outArray: IntArray?): IntArray

Gets all entities in this scene, optionally reusing an output array.

actual fun getEntities(): IntArray

Gets all entities in this scene.

actual fun getEntities(outArray: IntArray?): IntArray

Gets all entities in this scene, optionally reusing an output array.

actual fun getEntities(): IntArray

Gets all entities in this scene.

actual fun getEntities(outArray: IntArray?): IntArray

Gets all entities in this scene, optionally reusing an output array.

Link copied to clipboard
actual fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

expect fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

actual fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

actual fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

actual fun hasEntity(entity: Entity): Boolean

Tests whether an entity is in this scene.

Link copied to clipboard
actual fun remove(entity: Entity)

Removes a single entity from this scene.

expect fun remove(entity: Entity)

Removes a single entity from this scene.

actual fun remove(entity: Entity)

Removes a single entity from this scene.

actual fun remove(entity: Entity)

Removes a single entity from this scene.

actual fun remove(entity: Entity)

Removes a single entity from this scene.

Link copied to clipboard
actual fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

expect fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

actual fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

actual fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

actual fun removeEntities(entities: IntArray)

Removes multiple entities from this scene.

Link copied to clipboard
actual fun removeEntity(entity: Entity)

Removes a single entity from this scene.

expect fun removeEntity(entity: Entity)

Removes a single entity from this scene.

actual fun removeEntity(entity: Entity)

Removes a single entity from this scene.

actual fun removeEntity(entity: Entity)

Removes a single entity from this scene.

actual fun removeEntity(entity: Entity)

Removes a single entity from this scene.

Generated by Dokka
© 2026 Copyright