Enum let_engine::settings::PresentMode

#[non_exhaustive]
pub enum PresentMode {
    Immediate,
    Mailbox,
    Fifo,
}

The presentation action to take when presenting images to the window.

In game engine terms this affects “VSync”.

Immediate mode is the only one that does not have “VSync”.

When designing in game graphics settings this is the setting that gets changed when users select the VSync option.

The vsync options may include higher latency than the other ones.

It is not recommended dynamically switching between those during the game, as they may cause visual artifacts or noticable changes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Immediate

This one has no vsync and presents the image as soon as it is available.

This may happen while the image is presenting, so it may cause tearing.

This present mode has the lowest latency compared to every other mode, so this is the option for most fast paced games where latency matters.

This present mode may not be available on every device.

Mailbox

This present mode has a waiting slot for the next image to be presented after the current one has finished presenting. This mode also does not block the drawing thread, drawing images, even when they will not get presented.

This means there is no tearing and with just one waiting slot also not that much latency.

This option is recommended if Immediate is not available and also for games that focus visual experience over latency, as this one does not have tearing.

It may also not be available on every device.

Fifo

Means first in first out.

This present mode is also known as “vsync on”. It blocks the thread and only draws and presents images if the present buffer is finished drawing to the screen.

It is guaranteed to be available on every device.

Trait Implementations

impl Clone for PresentMode

fn clone(&self) -> PresentMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PresentMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PresentMode> for PresentMode

fn from(value: PresentMode) -> PresentMode

Converts to this type from the input type.

impl From<PresentMode> for PresentMode

fn from(value: PresentMode) -> PresentMode

Converts to this type from the input type.

impl PartialEq for PresentMode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PresentMode

impl Eq for PresentMode

impl StructuralPartialEq for PresentMode