filament/io.github.erkko68.filament/Fence

Fence

class Fence(nativeHandle: NativePointer, engine: NativePointer = NullPointer)

Fence is used to synchronize the application main thread with filament's rendering thread.

Constructors

constructor(nativeHandle: NativePointer, engine: NativePointer = NullPointer)

Types

object Companion

enum FenceStatus : Enum<Fence.FenceStatus>

Error codes for Fence.wait()

enum Mode : Enum<Fence.Mode>

Mode controls the behavior of the command stream when calling wait().

Properties

val nativeObject: NativePointer

Functions

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "the timeout is clamped to 0 — wasm is single-threaded, so wait() is a non-blocking poll (a FLUSH has already executed every command).")

fun wait(mode: Fence.Mode = Mode.FLUSH, timeout: Long = FENCE_WAIT_FOR_EVER): Fence.FenceStatus

Client-side wait on the Fence.