filament/io.github.erkko68.filament/Engine/Companion

Companion

object Companion

Properties

maxStereoscopicEyes

val maxStereoscopicEyes: Int

The maximum number of stereoscopic eyes supported by Filament.

steadyClockTimeNano

val steadyClockTimeNano: Long

The current time in nanoseconds since the epoch of the steady clock, the one Renderer.beginFrame uses.

Functions

create

fun create(backend: Engine.Backend = Backend.DEFAULT, sharedContext: Any? = null, config: Engine.Config? = null): Engine?

Creates an Engine, or returns null if the backend couldn't be initialized.

createAsync

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "creates the engine synchronously and calls back before returning: the wasm build has no threads.")

fun createAsync(backend: Engine.Backend = Backend.DEFAULT, sharedContext: Any? = null, config: Engine.Config? = null, callback: (Engine.Token) -> Unit)

Creates an Engine asynchronously; see Builder.build.

destroy

fun destroy(engine: Engine?)

Destroys engine and every resource it still tracks. Blocking; destroy the Renderer, View, Scene and other resources first.

getEngine

fun getEngine(token: Engine.Token): Engine?

The Engine createAsync or Builder.build created, or null if it couldn't be. Call it on the thread that started the creation.