Struct WindowPlugin

pub struct WindowPlugin {
    pub primary_window: Option<Window>,
    pub exit_condition: ExitCondition,
    pub close_when_requested: bool,
}

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

Fields

primary_window: Option<Window>

Settings for the primary window.

Some(custom_window) will spawn an entity with custom_window and PrimaryWindow as components. None will not spawn a primary window.

Defaults to Some(Window::default()).

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

exit_condition: ExitCondition

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 to either ExitCondition::OnAllClosed or ExitCondition::OnPrimaryClosed.

ExitCondition::OnAllClosed will add exit_on_all_closed to Update. ExitCondition::OnPrimaryClosed will add exit_on_primary_closed to Update.

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 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 ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

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