Enum bevy_winit::UpdateMode

pub enum UpdateMode {
    Continuous,
    Reactive {
        max_wait: Duration,
    },
    ReactiveLowPower {
        max_wait: Duration,
    },
}

Configure how the winit event loop should update.

Variants

Continuous

The event loop will update continuously, running as fast as possible.

Reactive

Fields

max_wait: Duration

The maximum time to wait before the event loop runs again.

Note that Bevy will wait indefinitely if the duration is too high (such as Duration::MAX).

The event loop will only update if there is a winit event, a redraw is requested, or the maximum wait time has elapsed.

Note

Once the app has executed all bevy systems and reaches the end of the event loop, there is no way to force the app to wake and update again, unless a winit event (such as user input, or the window being resized) is received or the time limit is reached.

ReactiveLowPower

Fields

max_wait: Duration

The maximum time to wait before the event loop runs again.

Note that Bevy will wait indefinitely if the duration is too high (such as Duration::MAX).

The event loop will only update if there is a winit event from direct interaction with the window (e.g. mouseover), a redraw is requested, or the maximum wait time has elapsed.

Note

Once the app has executed all bevy systems and reaches the end of the event loop, there is no way to force the app to wake and update again, unless a winit event (such as user input, or the window being resized) is received or the time limit is reached.

Differences from UpdateMode::Reactive

Unlike UpdateMode::Reactive, this mode will ignore winit events that aren’t directly caused by interaction with the window. For example, you might want to use this mode when the window is not focused, to only re-draw your bevy app when the cursor is over the window, but not when the mouse moves somewhere else on the screen. This helps to significantly reduce power consumption by only updated the app when absolutely necessary.

Trait Implementations

impl Debug for UpdateMode

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

Formats the value using the given formatter.