filament/io.github.erkko68.filament/SwapChain

SwapChain

class SwapChain(nativeHandle: NativePointer, window: NativePointer = NullPointer)

A SwapChain represents an Operating System's native renderable surface.

Typically, it's a native window or a view. A SwapChain is initialized from a native object, which must be of the proper type for each platform Filament is running on:

Platform	Native Type
Android	ANativeWindow*
macOS - OpenGL	NSView*
macOS - Metal	CAMetalLayer*
iOS - OpenGL	CAEAGLLayer*
iOS - Metal	CAMetalLayer*
X11	Window
Windows	HWND

Constructors

SwapChain

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

Types

ChangeFrameRateStrategy

enum ChangeFrameRateStrategy : Enum<SwapChain.ChangeFrameRateStrategy>

Strategy for applying a frame rate change that is not seamless.

Companion

object Companion

FrameRateCompatibility

enum FrameRateCompatibility : Enum<SwapChain.FrameRateCompatibility>

Frame rate compatibility strategy for setFrameRate.

Properties

isFrameRateChangeSupported

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "returns FALSE — display frame rate switching is not supported on web; pacing is browser-managed.")

val isFrameRateChangeSupported: Engine.FeatureState

Returns whether this SwapChain supports the setFrameRate API.

isFrameScheduledCallbackSet

val isFrameScheduledCallbackSet: Boolean

Checks if a frame scheduled callback is currently set on this SwapChain.

nativeObject

val nativeObject: NativePointer

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

nativeWindow

val nativeWindow: NativePointer?

Gets the native window/surface associated with this SwapChain.

Functions

setFrameCompletedCallback

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "never fires — OpenGLDriver (the WebGL backend) implements the frame-completed callback as a no-op.")

fun setFrameCompletedCallback(callback: () -> Unit? = null)

Sets a callback to be invoked when a frame's rendering has completed on the GPU.

setFrameRate

fun setFrameRate(frameRate: Float)

fun setFrameRate(frameRate: Float, compatibility: SwapChain.FrameRateCompatibility, strategy: SwapChain.ChangeFrameRateStrategy)

Sets the intended frame rate for this SwapChain.

setFrameScheduledCallback

fun setFrameScheduledCallback(callback: () -> Unit? = null)

Sets a callback to be invoked when a frame is scheduled for presentation.

SwapChain

See also

Constructors

Types

Properties

Functions