filament/io.github.erkko68.filament/Engine

Engine

actual class Engine

Engine is Filament's main entry-point.

An Engine instance keeps track of all resources created by the user and manages the rendering thread as well as the hardware renderer.

To use Filament, an Engine instance must be created first using Engine.create(). Engine essentially represents (or is associated with) a hardware context (e.g., an OpenGL ES context or a Vulkan device).

Rendering typically happens in an operating system's window (which can be fullscreen), which is managed by a Renderer.

A typical Filament render loop looks like this:

val engine = Engine.create()
val swapChain = engine.createSwapChain(nativeWindow)
val renderer = engine.createRenderer()
val scene = engine.createScene()
val view = engine.createView()

view.setScene(scene)

while (!quit) {
    // Wait for VSYNC and user input events
    if (renderer.beginFrame(swapChain)) {
        renderer.render(view)
        renderer.endFrame()
    }
}

engine.destroy(view)
engine.destroy(scene)
engine.destroy(renderer)
engine.destroy(swapChain)
Engine.destroy(engine)

expect class Engine

Engine is Filament's main entry-point.

An Engine instance keeps track of all resources created by the user and manages the rendering thread as well as the hardware renderer.

Rendering typically happens in an operating system's window (which can be fullscreen), which is managed by a Renderer.

A typical Filament render loop looks like this:

val engine = Engine.create()
val swapChain = engine.createSwapChain(nativeWindow)
val renderer = engine.createRenderer()
val scene = engine.createScene()
val view = engine.createView()

view.setScene(scene)

while (!quit) {
    // Wait for VSYNC and user input events
    if (renderer.beginFrame(swapChain)) {
        renderer.render(view)
        renderer.endFrame()
    }
}

engine.destroy(view)
engine.destroy(scene)
engine.destroy(renderer)
engine.destroy(swapChain)
Engine.destroy(engine)

actual class Engine

Engine is Filament's main entry-point.

An Engine instance keeps track of all resources created by the user and manages the rendering thread as well as the hardware renderer.

Rendering typically happens in an operating system's window (which can be fullscreen), which is managed by a Renderer.

A typical Filament render loop looks like this:

val engine = Engine.create()
val swapChain = engine.createSwapChain(nativeWindow)
val renderer = engine.createRenderer()
val scene = engine.createScene()
val view = engine.createView()

view.setScene(scene)

while (!quit) {
    // Wait for VSYNC and user input events
    if (renderer.beginFrame(swapChain)) {
        renderer.render(view)
        renderer.endFrame()
    }
}

engine.destroy(view)
engine.destroy(scene)
engine.destroy(renderer)
engine.destroy(swapChain)
Engine.destroy(engine)

actual class Engine

Engine is Filament's main entry-point.

An Engine instance keeps track of all resources created by the user and manages the rendering thread as well as the hardware renderer.

Rendering typically happens in an operating system's window (which can be fullscreen), which is managed by a Renderer.

A typical Filament render loop looks like this:

val engine = Engine.create()
val swapChain = engine.createSwapChain(nativeWindow)
val renderer = engine.createRenderer()
val scene = engine.createScene()
val view = engine.createView()

view.setScene(scene)

while (!quit) {
    // Wait for VSYNC and user input events
    if (renderer.beginFrame(swapChain)) {
        renderer.render(view)
        renderer.endFrame()
    }
}

engine.destroy(view)
engine.destroy(scene)
engine.destroy(renderer)
engine.destroy(swapChain)
Engine.destroy(engine)

actual class Engine

Engine is Filament's main entry-point.

An Engine instance keeps track of all resources created by the user and manages the rendering thread as well as the hardware renderer.

Rendering typically happens in an operating system's window (which can be fullscreen), which is managed by a Renderer.

A typical Filament render loop looks like this:

val engine = Engine.create()
val swapChain = engine.createSwapChain(nativeWindow)
val renderer = engine.createRenderer()
val scene = engine.createScene()
val view = engine.createView()

view.setScene(scene)

while (!quit) {
    // Wait for VSYNC and user input events
    if (renderer.beginFrame(swapChain)) {
        renderer.render(view)
        renderer.endFrame()
    }
}

engine.destroy(view)
engine.destroy(scene)
engine.destroy(renderer)
engine.destroy(swapChain)
Engine.destroy(engine)

Constructors

Engine

constructor(nativeEngine: Engine)

constructor(nativeHandle: MemorySegment?)

constructor(nativeHandle: CPointer<FilaEngine>?)

Types

Backend

actual enum Backend : Enum<Engine.Backend>

Rendering backend selection.

expect enum Backend : Enum<Engine.Backend>

Rendering backend selection.

actual enum Backend : Enum<Engine.Backend>

Rendering backend selection.

actual enum Backend : Enum<Engine.Backend>

Rendering backend selection.

actual enum Backend : Enum<Engine.Backend>

Rendering backend selection.

Builder

actual class Builder

Builder for creating and configuring an Engine instance.

expect class Builder

Builder for creating and configuring an Engine instance.

actual class Builder

Builder for creating and configuring an Engine instance.

actual class Builder

Builder for creating and configuring an Engine instance.

actual class Builder

Builder for creating and configuring an Engine instance.

Companion

actual object Companion

expect object Companion

actual object Companion

CompilerPriorityQueue

actual enum CompilerPriorityQueue : Enum<Engine.CompilerPriorityQueue>

Material compilation priority queue.

expect enum CompilerPriorityQueue : Enum<Engine.CompilerPriorityQueue>

Material compilation priority queue.

actual enum CompilerPriorityQueue : Enum<Engine.CompilerPriorityQueue>

Material compilation priority queue.

actual enum CompilerPriorityQueue : Enum<Engine.CompilerPriorityQueue>

Material compilation priority queue.

actual enum CompilerPriorityQueue : Enum<Engine.CompilerPriorityQueue>

Material compilation priority queue.

Config

actual class Config

Advanced parameters for customizing Engine initialization.

expect class Config

Advanced parameters for customizing Engine initialization.

actual class Config

Advanced parameters for customizing Engine initialization.

actual class Config

Advanced parameters for customizing Engine initialization.

actual class Config

Advanced parameters for customizing Engine initialization.

FeatureLevel

actual enum FeatureLevel : Enum<Engine.FeatureLevel>

Backend feature levels control available rendering capabilities and performance characteristics.

expect enum FeatureLevel : Enum<Engine.FeatureLevel>

Backend feature levels control available rendering capabilities and performance characteristics.

actual enum FeatureLevel : Enum<Engine.FeatureLevel>

Backend feature levels control available rendering capabilities and performance characteristics.

actual enum FeatureLevel : Enum<Engine.FeatureLevel>

Backend feature levels control available rendering capabilities and performance characteristics.

actual enum FeatureLevel : Enum<Engine.FeatureLevel>

Backend feature levels control available rendering capabilities and performance characteristics.

FeatureState

actual enum FeatureState : Enum<Engine.FeatureState>

Feature state for conditional material compilation.

expect enum FeatureState : Enum<Engine.FeatureState>

Feature state for conditional material compilation.

actual enum FeatureState : Enum<Engine.FeatureState>

Feature state for conditional material compilation.

actual enum FeatureState : Enum<Engine.FeatureState>

Feature state for conditional material compilation.

actual enum FeatureState : Enum<Engine.FeatureState>

Feature state for conditional material compilation.

GpuContextPriority

actual enum GpuContextPriority : Enum<Engine.GpuContextPriority>

GPU context priority for work scheduling and preemption.

expect enum GpuContextPriority : Enum<Engine.GpuContextPriority>

GPU context priority for work scheduling and preemption.

actual enum GpuContextPriority : Enum<Engine.GpuContextPriority>

GPU context priority for work scheduling and preemption.

actual enum GpuContextPriority : Enum<Engine.GpuContextPriority>

GPU context priority for work scheduling and preemption.

actual enum GpuContextPriority : Enum<Engine.GpuContextPriority>

GPU context priority for work scheduling and preemption.

StereoscopicType

actual enum StereoscopicType : Enum<Engine.StereoscopicType>

Stereoscopic rendering technique for VR and 3D displays.

expect enum StereoscopicType : Enum<Engine.StereoscopicType>

Stereoscopic rendering technique for VR and 3D displays.

actual enum StereoscopicType : Enum<Engine.StereoscopicType>

Stereoscopic rendering technique for VR and 3D displays.

actual enum StereoscopicType : Enum<Engine.StereoscopicType>

Stereoscopic rendering technique for VR and 3D displays.

actual enum StereoscopicType : Enum<Engine.StereoscopicType>

Stereoscopic rendering technique for VR and 3D displays.

Properties

backend

actual val backend: Engine.Backend

The rendering backend being used by this Engine.

expect val backend: Engine.Backend

The rendering backend being used by this Engine.

actual val backend: Engine.Backend

The rendering backend being used by this Engine.

actual val backend: Engine.Backend

The rendering backend being used by this Engine.

actual val backend: Engine.Backend

The rendering backend being used by this Engine.

config

actual val config: Engine.Config

The Engine's advanced configuration — the Config object used when creating this Engine.

expect val config: Engine.Config

The Engine's advanced configuration — the Config object used when creating this Engine.

actual val config: Engine.Config

The Engine's advanced configuration — the Config object used when creating this Engine.

actual val config: Engine.Config

The Engine's advanced configuration — the Config object used when creating this Engine.

actual val config: Engine.Config

The Engine's advanced configuration — the Config object used when creating this Engine.

jsCanvas

val jsCanvas: HTMLCanvasElement?

jsEngine

val jsEngine: Engine

nativeEngine

val nativeEngine: Engine

nativeHandle

var nativeHandle: MemorySegment?

var nativeHandle: CPointer<FilaEngine>?

paused

actual var paused: Boolean

Whether rendering is currently paused. Set to pause or resume rendering.

expect var paused: Boolean

Whether rendering is currently paused. Set to pause or resume rendering.

actual var paused: Boolean

Whether rendering is currently paused. Set to pause or resume rendering.

actual var paused: Boolean

Whether rendering is currently paused. Set to pause or resume rendering.

actual var paused: Boolean

Whether rendering is currently paused. Set to pause or resume rendering.

supportedFeatureLevel

actual val supportedFeatureLevel: Engine.FeatureLevel

The highest feature level supported by this backend.

expect val supportedFeatureLevel: Engine.FeatureLevel

The highest feature level supported by this backend.

actual val supportedFeatureLevel: Engine.FeatureLevel

The highest feature level supported by this backend.

actual val supportedFeatureLevel: Engine.FeatureLevel

The highest feature level supported by this backend.

actual val supportedFeatureLevel: Engine.FeatureLevel

The highest feature level supported by this backend.

Functions

compile

actual fun compile(priority: Engine.CompilerPriorityQueue, material: Material, view: View, shadowReceiver: Engine.FeatureState, skinning: Engine.FeatureState, callback: () -> Unit?)

Asynchronously compile a material variant for specific rendering features.

expect fun compile(priority: Engine.CompilerPriorityQueue, material: Material, view: View, shadowReceiver: Engine.FeatureState, skinning: Engine.FeatureState, callback: () -> Unit? = null)

Asynchronously compile a material variant for specific rendering features.

actual fun compile(priority: Engine.CompilerPriorityQueue, material: Material, view: View, shadowReceiver: Engine.FeatureState, skinning: Engine.FeatureState, callback: () -> Unit?)

Asynchronously compile a material variant for specific rendering features.

actual fun compile(priority: Engine.CompilerPriorityQueue, material: Material, view: View, shadowReceiver: Engine.FeatureState, skinning: Engine.FeatureState, callback: () -> Unit?)

Asynchronously compile a material variant for specific rendering features.

actual fun compile(priority: Engine.CompilerPriorityQueue, material: Material, view: View, shadowReceiver: Engine.FeatureState, skinning: Engine.FeatureState, callback: () -> Unit?)

Asynchronously compile a material variant for specific rendering features.

createCamera

actual fun createCamera(): Camera

Create a Camera as a standalone component.

actual fun createCamera(entity: Entity): Camera

Create a Camera attached to an entity.

expect fun createCamera(): Camera

Create a Camera as a standalone component.

expect fun createCamera(entity: Entity): Camera

Create a Camera attached to an entity.

actual fun createCamera(): Camera

Create a Camera as a standalone component.

actual fun createCamera(entity: Entity): Camera

Create a Camera attached to an entity.

actual fun createCamera(): Camera

Create a Camera as a standalone component.

actual fun createCamera(entity: Entity): Camera

Create a Camera attached to an entity.

actual fun createCamera(): Camera

Create a Camera as a standalone component.

actual fun createCamera(entity: Entity): Camera

Create a Camera attached to an entity.

createFence

actual fun createFence(): Fence

Create a Fence for GPU synchronization.

expect fun createFence(): Fence

Create a Fence for GPU synchronization.

actual fun createFence(): Fence

Create a Fence for GPU synchronization.

actual fun createFence(): Fence

Create a Fence for GPU synchronization.

actual fun createFence(): Fence

Create a Fence for GPU synchronization.

createRenderer

actual fun createRenderer(): Renderer

Create a Renderer associated with this Engine.

expect fun createRenderer(): Renderer

Create a Renderer associated with this Engine.

actual fun createRenderer(): Renderer

Create a Renderer associated with this Engine.

actual fun createRenderer(): Renderer

Create a Renderer associated with this Engine.

actual fun createRenderer(): Renderer

Create a Renderer associated with this Engine.

createScene

actual fun createScene(): Scene

Create a Scene for collecting renderable objects.

expect fun createScene(): Scene

Create a Scene for collecting renderable objects.

actual fun createScene(): Scene

Create a Scene for collecting renderable objects.

actual fun createScene(): Scene

Create a Scene for collecting renderable objects.

actual fun createScene(): Scene

Create a Scene for collecting renderable objects.

createSwapChain

actual fun createSwapChain(surface: NativeSurface): SwapChain

Create a SwapChain from a native display surface.

actual fun createSwapChain(surface: NativeSurface, flags: Long): SwapChain

Create a SwapChain from a native display surface with flags.

actual fun createSwapChain(width: Int, height: Int, flags: Long): SwapChain

Create an offscreen SwapChain of specified dimensions.

expect fun createSwapChain(surface: NativeSurface): SwapChain

Create a SwapChain from a native display surface.

expect fun createSwapChain(surface: NativeSurface, flags: Long): SwapChain

Create a SwapChain from a native display surface with flags.

expect fun createSwapChain(width: Int, height: Int, flags: Long): SwapChain

Create an offscreen SwapChain of specified dimensions.

actual fun createSwapChain(surface: NativeSurface): SwapChain

Create a SwapChain from a native display surface.

actual fun createSwapChain(surface: NativeSurface, flags: Long): SwapChain

Create a SwapChain from a native display surface with flags.

actual fun createSwapChain(width: Int, height: Int, flags: Long): SwapChain

Create an offscreen SwapChain of specified dimensions.

actual fun createSwapChain(surface: NativeSurface): SwapChain

Create a SwapChain from a native display surface.

actual fun createSwapChain(surface: NativeSurface, flags: Long): SwapChain

Create a SwapChain from a native display surface with flags.

actual fun createSwapChain(width: Int, height: Int, flags: Long): SwapChain

Create an offscreen SwapChain of specified dimensions.

actual fun createSwapChain(surface: NativeSurface): SwapChain

Create a SwapChain from a native display surface.

actual fun createSwapChain(surface: NativeSurface, flags: Long): SwapChain

Create a SwapChain from a native display surface with flags.

actual fun createSwapChain(width: Int, height: Int, flags: Long): SwapChain

Create an offscreen SwapChain of specified dimensions.

createView

actual fun createView(): View

Create a View for rendering.

expect fun createView(): View

Create a View for rendering.

actual fun createView(): View

Create a View for rendering.

actual fun createView(): View

Create a View for rendering.

actual fun createView(): View

Create a View for rendering.

destroy

actual fun destroy()

Destroy the Engine and all its resources.

expect fun destroy()

Destroy the Engine and all its resources.

actual fun destroy()

Destroy the Engine and all its resources.

actual fun destroy()

Destroy the Engine and all its resources.

actual fun destroy()

Destroy the Engine and all its resources.

destroyCamera

actual fun destroyCamera(camera: Camera)

Destroy a Camera.

expect fun destroyCamera(camera: Camera)

Destroy a Camera.

actual fun destroyCamera(camera: Camera)

Destroy a Camera.

actual fun destroyCamera(camera: Camera)

Destroy a Camera.

actual fun destroyCamera(camera: Camera)

Destroy a Camera.

destroyCameraComponent

actual fun destroyCameraComponent(entity: Entity)