Struct SDL_GPUPresentMode

#[repr(transparent)]
pub struct SDL_GPUPresentMode(pub i32);

Available on crate feature dep_sdl3 only.

Specifies the timing that will be used to present swapchain textures to the OS.

VSYNC mode will always be supported. IMMEDIATE and MAILBOX modes may not be supported on certain systems.

It is recommended to query SDL_WindowSupportsGPUPresentMode after claiming the window if you wish to change the present mode to IMMEDIATE or MAILBOX.

• VSYNC: Waits for vblank before presenting. No tearing is possible. If there is a pending image to present, the new image is enqueued for presentation. Disallows tearing at the cost of visual latency.
• IMMEDIATE: Immediately presents. Lowest latency option, but tearing may occur.
• MAILBOX: Waits for vblank before presenting. No tearing is possible. If there is a pending image to present, the pending image is replaced by the new image. Similar to VSYNC, but with reduced visual latency.

Availability

This enum is available since SDL 3.2.0.

See also

• SDL_SetGPUSwapchainParameters
• SDL_WindowSupportsGPUPresentMode
• SDL_WaitAndAcquireGPUSwapchainTexture

Known values (sdl3-sys)

Associated constant	Global constant	Description
VSYNC	SDL_GPU_PRESENTMODE_VSYNC
IMMEDIATE	SDL_GPU_PRESENTMODE_IMMEDIATE
MAILBOX	SDL_GPU_PRESENTMODE_MAILBOX

Tuple Fields

0: i32

Implementations

impl SDL_GPUPresentMode

pub const VSYNC: SDL_GPUPresentMode

pub const IMMEDIATE: SDL_GPUPresentMode

pub const MAILBOX: SDL_GPUPresentMode

Trait Implementations

impl Clone for SDL_GPUPresentMode

fn clone(&self) -> SDL_GPUPresentMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SDL_GPUPresentMode

fn default() -> SDL_GPUPresentMode

Returns the “default value” for a type.

impl From<SDL_GPUPresentMode> for i32

fn from(value: SDL_GPUPresentMode) -> i32

Converts to this type from the input type.

impl Hash for SDL_GPUPresentMode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SDL_GPUPresentMode

fn cmp(&self, other: &SDL_GPUPresentMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SDL_GPUPresentMode

fn eq(&self, other: &SDL_GPUPresentMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SDL_GPUPresentMode

fn partial_cmp(&self, other: &SDL_GPUPresentMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SDL_GPUPresentMode

impl Eq for SDL_GPUPresentMode

impl StructuralPartialEq for SDL_GPUPresentMode