Struct bevy::window::WindowPlugin

pub struct WindowPlugin {
    pub window: WindowDescriptor,
    pub add_primary_window: bool,
    pub exit_on_all_closed: bool,
    pub close_when_requested: bool,
}

A Plugin that defines an interface for windowing support in Bevy.

Fields

window: WindowDescriptor

add_primary_window: bool

Whether to create a window when added.

Note that if there are no windows, by default the App will exit, due to exit_on_all_closed.

exit_on_all_closed: bool

Whether to exit the app when there are no open windows.

If disabling this, ensure that you send the [bevy_app::AppExit] event when the app should exit. If this does not occur, you will create ‘headless’ processes (processes without windows), which may surprise your users. It is recommended to leave this setting as true.

If true, this plugin will add exit_on_all_closed to CoreStage::PostUpdate.

close_when_requested: bool

Whether to close windows when they are requested to be closed (i.e. when the close button is pressed).

If true, this plugin will add close_when_requested to CoreStage::Update. If this system (or a replacement) is not running, the close button will have no effect. This may surprise your users. It is recommended to leave this setting as true.

Trait Implementations

impl Default for WindowPlugin

fn default() -> WindowPlugin

Returns the “default value” for a type.

impl Plugin for WindowPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.