Struct bevy::winit::WinitSettings

pub struct WinitSettings {
    pub return_from_run: bool,
    pub focused_mode: UpdateMode,
    pub unfocused_mode: UpdateMode,
}

Settings for the WinitPlugin.

Fields

return_from_run: bool

Controls how the EventLoop is deployed.

• If this value is set to false (default), run is called, and exiting the loop will terminate the program.
• If this value is set to true, run_return is called, and exiting the loop will return control to the caller.

Note: This cannot be changed while the loop is running. winit also discourages use of run_return.

Supported platforms

run_return is only available on the following target_os environments:

• windows
• macos
• linux
• freebsd
• openbsd
• netbsd
• dragonfly

The runner will panic if this is set to true on other platforms.

focused_mode: UpdateMode

Determines how frequently the application can update when it has focus.

unfocused_mode: UpdateMode

Determines how frequently the application can update when it’s out of focus.

Implementations

impl WinitSettings

pub fn game() -> WinitSettings

Default settings for games.

Continuous if windows have focus, ReactiveLowPower otherwise.

pub fn desktop_app() -> WinitSettings

Default settings for desktop applications.

Reactive if windows have focus, ReactiveLowPower otherwise.

pub fn update_mode(&self, focused: bool) -> &UpdateMode

Returns the current UpdateMode.

Note: The output depends on whether the window has focus or not.

Trait Implementations

impl Debug for WinitSettings

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

Formats the value using the given formatter.

impl Default for WinitSettings

fn default() -> WinitSettings

Returns the “default value” for a type.

impl Resource for WinitSettingswhere WinitSettings: Send + Sync + 'static,