forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move the configuration of the WindowPlugin to a resource (#5227)

Browse Source 
# Objective

It is currently hard to configure the `WindowPlugin`, as it is added as part of the `DefaultPlugins`. Ideally this should not be difficult.

## Solution

Remove the configuration from the plugin itself and put it as a `Resource`, similar to how it is done for almost all other plugins.

## Migration Guide

If you are currently configuring the behavior of the `WindowPlugin`, by constructing it manually, then you will need to instead create add the `WindowSettings` as a resource.
This commit is contained in:
Tethys Svensson 2022-07-08 01:14:23 +00:00
parent 6b073ee412
commit 11c4514023
1 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
crates/bevy_window/src/lib.rs
View File

@ -24,8 +24,12 @@ pub mod prelude {
use bevy_app::prelude::*; use bevy_app::prelude::*;
use bevy_ecs::{event::Events, schedule::SystemLabel}; use bevy_ecs::{event::Events, schedule::SystemLabel};
/// A [`Plugin`] that defines an interface for windowing support in Bevy. /// The configuration information for the [`WindowPlugin`].
pub struct WindowPlugin { ///
/// It can be added as a [`Resource`](bevy_ecs::system::Resource) before the [`WindowPlugin`]
/// runs, to configure how it behaves.
#[derive(Clone)]
pub struct WindowSettings {
/// Whether to create a window when added. /// Whether to create a window when added.
/// ///
/// Note that if there are no windows, by default the App will exit, /// Note that if there are no windows, by default the App will exit,
@ -49,9 +53,9 @@ pub struct WindowPlugin {
pub close_when_requested: bool, pub close_when_requested: bool,
} }
impl Default for WindowPlugin { impl Default for WindowSettings {
fn default() -> Self { fn default() -> Self {
WindowPlugin { WindowSettings {
add_primary_window: true, add_primary_window: true,
exit_on_all_closed: true, exit_on_all_closed: true,
close_when_requested: true, close_when_requested: true,
@ -59,6 +63,10 @@ impl Default for WindowPlugin {
} }
} }
/// A [`Plugin`] that defines an interface for windowing support in Bevy.
#[derive(Default)]
pub struct WindowPlugin;
impl Plugin for WindowPlugin { impl Plugin for WindowPlugin {
fn build(&self, app: &mut App) { fn build(&self, app: &mut App) {
app.add_event::<WindowResized>() app.add_event::<WindowResized>()
@ -78,11 +86,17 @@ impl Plugin for WindowPlugin {
.add_event::<WindowMoved>() .add_event::<WindowMoved>()
.init_resource::<Windows>(); .init_resource::<Windows>();
if self.add_primary_window { let settings = app
.world
.get_resource::<WindowSettings>()
.cloned()
.unwrap_or_default();
if settings.add_primary_window {
let window_descriptor = app let window_descriptor = app
.world .world
.get_resource::<WindowDescriptor>() .get_resource::<WindowDescriptor>()
.map(|descriptor| (*descriptor).clone()) .cloned()
.unwrap_or_default(); .unwrap_or_default();
let mut create_window_event = app.world.resource_mut::<Events<CreateWindow>>(); let mut create_window_event = app.world.resource_mut::<Events<CreateWindow>>();
create_window_event.send(CreateWindow { create_window_event.send(CreateWindow {
@ -91,10 +105,10 @@ impl Plugin for WindowPlugin {
}); });
} }
if self.exit_on_all_closed { if settings.exit_on_all_closed {
app.add_system(exit_on_all_closed); app.add_system(exit_on_all_closed);
} }
if self.close_when_requested { if settings.close_when_requested {
app.add_system(close_when_requested); app.add_system(close_when_requested);
} }
} }