WGPUPresentMode

enum WGPUPresentMode : Enum<WGPUPresentMode>

Describes when and in which order frames are presented on the screen when wgpuSurfacePresent is called.

Entries

Present mode is not specified. Use the default.

The presentation of the image to the user waits for the next vertical blanking period to update in a first-in, first-out manner. Tearing cannot be observed and frame-loop will be limited to the display's refresh rate. This is the only mode that's always available.

FifoRelaxed

The presentation of the image to the user tries to wait for the next vertical blanking period but may decide to not wait if a frame is presented late. Tearing can sometimes be observed but late-frame don't produce a full-frame stutter in the presentation. This is still a first-in, first-out mechanism so a frame-loop will be limited to the display's refresh rate.

Immediate

The presentation of the image to the user is updated immediately without waiting for a vertical blank. Tearing can be observed but latency is minimized.

Mailbox

The presentation of the image to the user waits for the next vertical blanking period to update to the latest provided image. Tearing cannot be observed and a frame-loop is not limited to the display's refresh rate.

Types

Companion

object Companion

Properties

name

val name: String

ordinal

val ordinal: Int

value

val value: Int

Functions

valueOf

fun valueOf(value: String): WGPUPresentMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<WGPUPresentMode>

Returns an array containing the constants of this enum type, in the order they're declared.