filament/io.github.erkko68.filament/SwapChain

SwapChain

actual class SwapChain

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:

PlatformNative Type
AndroidANativeWindow*
macOS - OpenGLNSView*
macOS - MetalCAMetalLayer*
iOS - OpenGLCAEAGLLayer*
iOS - MetalCAMetalLayer*
X11Window
WindowsHWND

See also

expect class SwapChain

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:

PlatformNative Type
AndroidANativeWindow*
macOS - OpenGLNSView*
macOS - MetalCAMetalLayer*
iOS - OpenGLCAEAGLLayer*
iOS - MetalCAMetalLayer*
X11Window
WindowsHWND

See also

actual class SwapChain(jsSwapChain: SwapChain)

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:

PlatformNative Type
AndroidANativeWindow*
macOS - OpenGLNSView*
macOS - MetalCAMetalLayer*
iOS - OpenGLCAEAGLLayer*
iOS - MetalCAMetalLayer*
X11Window
WindowsHWND

See also

actual class SwapChain

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:

PlatformNative Type
AndroidANativeWindow*
macOS - OpenGLNSView*
macOS - MetalCAMetalLayer*
iOS - OpenGLCAEAGLLayer*
iOS - MetalCAMetalLayer*
X11Window
WindowsHWND

See also

actual class SwapChain

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:

PlatformNative Type
AndroidANativeWindow*
macOS - OpenGLNSView*
macOS - MetalCAMetalLayer*
iOS - OpenGLCAEAGLLayer*
iOS - MetalCAMetalLayer*
X11Window
WindowsHWND

See also

Constructors

Link copied to clipboard
constructor(jsSwapChain: SwapChain)

Types

Link copied to clipboard
actual object Companion
expect object Companion
actual object Companion
actual object Companion
actual object Companion

Properties

Link copied to clipboard
actual val isFrameScheduledCallbackSet: Boolean

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

expect val isFrameScheduledCallbackSet: Boolean

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

actual val isFrameScheduledCallbackSet: Boolean

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

actual val isFrameScheduledCallbackSet: Boolean

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

actual val isFrameScheduledCallbackSet: Boolean

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

Link copied to clipboard
actual val nativeObject: Long

Gets the native SwapChain object handle.

expect val nativeObject: Long

Gets the native SwapChain object handle.

actual val nativeObject: Long

Gets the native SwapChain object handle.

actual val nativeObject: Long

Gets the native SwapChain object handle.

actual val nativeObject: Long

Gets the native SwapChain object handle.

Link copied to clipboard
val nativeSwapChain: SwapChain
Link copied to clipboard
actual val nativeWindow: Any?

Gets the native window/surface associated with this SwapChain.

expect val nativeWindow: Any?

Gets the native window/surface associated with this SwapChain.

actual val nativeWindow: Any?

Gets the native window/surface associated with this SwapChain.

actual val nativeWindow: Any?

Gets the native window/surface associated with this SwapChain.

actual val nativeWindow: Any?

Gets the native window/surface associated with this SwapChain.

Functions

Link copied to clipboard
actual fun setFrameCompletedCallback(callback: () -> Unit)

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

expect fun setFrameCompletedCallback(callback: () -> Unit)

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

actual fun setFrameCompletedCallback(callback: () -> Unit)

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

actual fun setFrameCompletedCallback(callback: () -> Unit)

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

actual fun setFrameCompletedCallback(callback: () -> Unit)

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

Link copied to clipboard
actual fun setFrameScheduledCallback(callback: () -> Unit)

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

expect fun setFrameScheduledCallback(callback: () -> Unit)

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

actual fun setFrameScheduledCallback(callback: () -> Unit)

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

actual fun setFrameScheduledCallback(callback: () -> Unit)

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

actual fun setFrameScheduledCallback(callback: () -> Unit)

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

Generated by Dokka
© 2026 Copyright