Merge pull request #1 from Weibye/rename-fields

Rename fields to `window` & add some missing documentation

Author: Aceeri

crates/bevy_render/src/camera/camera.rs

@@ -382,21 +382,21 @@ pub fn camera_system<T: CameraProjection + Component>(
     // handle resize events. latest events are handled first because we only want to resize each
     // window once
     for event in window_resized_events.iter().rev() {
-        if changed_window_ids.contains(&event.entity) {
+        if changed_window_ids.contains(&event.window) {
             continue;
         }
 
-        changed_window_ids.push(event.entity);
+        changed_window_ids.push(event.window);
     }
 
     // handle resize events. latest events are handled first because we only want to resize each
     // window once
     for event in window_created_events.iter().rev() {
-        if changed_window_ids.contains(&event.entity) {
+        if changed_window_ids.contains(&event.window) {
             continue;
         }
 
-        changed_window_ids.push(event.entity);
+        changed_window_ids.push(event.window);
     }
 
     let changed_image_handles: HashSet<&Handle<Image>> = image_asset_events

crates/bevy_window/src/event.rs

@@ -6,8 +6,9 @@ use bevy_math::{IVec2, Vec2};
 /// A window event that is sent whenever a window's logical size has changed.
 #[derive(Debug, Clone)]
 pub struct WindowResized {
-    pub entity: Entity,
-    /// The new logical width of the window
+    /// Window that has changed.
+    pub window: Entity,
+    /// The new logical width of the window.
     pub width: f64,
     /// The new logical height of the window.
     pub height: f64,
@@ -25,31 +26,35 @@ pub struct RequestRedraw;
 /// event will be sent in the handler for that event.
 #[derive(Debug, Clone)]
 pub struct WindowCreated {
-    pub entity: Entity,
+    /// Window that has been created.
+    pub window: Entity,
 }
 
 /// An event that is sent whenever the operating systems requests that a window
 /// be closed. This will be sent when the close button of the window is pressed.
 ///
 /// If the default [`WindowPlugin`] is used, these events are handled
-/// by [closing] the corresponding [`Window`].  
+/// by closing the corresponding [`Window`].  
 /// To disable this behaviour, set `close_when_requested` on the [`WindowPlugin`]
 /// to `false`.
 ///
 /// [`WindowPlugin`]: crate::WindowPlugin
 /// [`Window`]: crate::Window
 #[derive(Debug, Clone)]
 pub struct WindowCloseRequested {
-    pub entity: Entity,
+    /// Window to close.
+    pub window: Entity,
 }
 
 /// An event that is sent whenever a window is closed. This will be sent by the
 /// handler for [`WindowCloseRequested`] or similar.
 #[derive(Debug, Clone)]
 pub struct WindowClosed {
-    pub entity: Entity,
+    /// Window that has been closed.
+    /// TODO: Does this entity actually exist anymore?
+    pub window: Entity,
 }
-/// An event reporting that the mouse cursor has moved on a window.
+/// An event reporting that the mouse cursor has moved inside a window.
 ///
 /// The event is sent only if the cursor is over one of the application's windows.
 /// It is the translated version of [`WindowEvent::CursorMoved`] from the `winit` crate.
@@ -61,7 +66,7 @@ pub struct WindowClosed {
 #[derive(Debug, Clone)]
 pub struct CursorMoved {
     /// Window that the cursor moved inside.
-    pub entity: Entity,
+    pub window: Entity,
     /// The cursor position in logical pixels.
     pub position: Vec2,
 }
@@ -70,29 +75,30 @@ pub struct CursorMoved {
 #[derive(Debug, Clone)]
 pub struct CursorEntered {
     /// Window that the cursor entered.
-    pub entity: Entity,
+    pub window: Entity,
 }
 
 /// An event that is sent whenever the user's cursor leaves a window.
 #[derive(Debug, Clone)]
 pub struct CursorLeft {
     /// Window that the cursor left.
-    pub entity: Entity,
+    pub window: Entity,
 }
 
 /// An event that is sent whenever a window receives a character from the OS or underlying system.
 #[derive(Debug, Clone)]
 pub struct ReceivedCharacter {
     /// Window that received the character.
-    pub entity: Entity,
+    pub window: Entity,
+    /// Received character.
     pub char: char,
 }
 
 /// An event that indicates a window has received or lost focus.
 #[derive(Debug, Clone)]
 pub struct WindowFocused {
     /// Window that changed focus.
-    pub entity: Entity,
+    pub window: Entity,
     /// Whether it was focused (true) or lost focused (false).
     pub focused: bool,
 }
@@ -101,38 +107,43 @@ pub struct WindowFocused {
 #[derive(Debug, Clone)]
 pub struct WindowScaleFactorChanged {
     /// Window that had it's scale factor changed.
-    pub entity: Entity,
+    pub window: Entity,
     /// The new scale factor.
     pub scale_factor: f64,
 }
 
 /// An event that indicates a window's OS-reported scale factor has changed.
 #[derive(Debug, Clone)]
 pub struct WindowBackendScaleFactorChanged {
-    pub entity: Entity,
+    /// Window that had it's scale factor changed by the backend.
+    pub window: Entity,
+    /// The new scale factor.
     pub scale_factor: f64,
 }
 
 /// Events related to files being dragged and dropped on a window.
 #[derive(Debug, Clone)]
 pub enum FileDragAndDrop {
+    /// File is being dropped into a window. 
     DroppedFile {
         /// Window the file was dropped into.
-        entity: Entity,
+        window: Entity,
         /// Path to the file that was dropped in.
         path_buf: PathBuf,
     },
 
+    /// File is currently being hovered over a window.
     HoveredFile {
         /// Window a file is possibly going to be dropped into.
-        entity: Entity,
+        window: Entity,
         /// Path to the file that might be dropped in.
         path_buf: PathBuf,
     },
 
+    /// File hovering was cancelled.
     HoveredFileCancelled {
         /// Window that had a cancelled file drop.
-        entity: Entity,
+        window: Entity,
     },
 }
 

crates/bevy_window/src/lib.rs

@@ -29,11 +29,13 @@ use bevy_ecs::{entity::Entity, schedule::SystemLabel, system::Resource};
 /// runs, to configure how it behaves.
 #[derive(Resource, Clone)]
 pub struct WindowSettings {
+    
     /// 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`].
     pub add_primary_window: bool,
+    
     /// Whether to exit the app when there are no open windows.
     ///
     /// If disabling this, ensure that you send the [`bevy_app::AppExit`]
@@ -42,8 +44,8 @@ pub struct WindowSettings {
     /// surprise your users. It is recommended to leave this setting as `true`.
     ///
     /// If true, this plugin will add [`exit_on_all_closed`] to [`CoreStage::Update`].
-    // TODO: Update documentation here
     pub exit_condition: ExitCondition,
+    
     /// Whether to close windows when they are requested to be closed (i.e.
     /// when the close button is pressed).
     ///
@@ -107,18 +109,9 @@ impl Plugin for WindowPlugin {
             .unwrap_or_default();
 
         if settings.add_primary_window {
-            // TODO: Creating primary window should ideally be done through commands instead of the old way
-            // however, commands aren't executed until the end of the "build-stage"
-            // which means the primary-window does not exist until just before startup-systems starts running (?)
-            // which means bevy_render does not have a window to use as attach to during plugin build.
-
-            // Wishlist item; for this to work:
-            // app.add_startup_system(create_primary_window);
-            // or this:
-            // app.add_build_system(create_primary_window)
-
-            // TODO: The unwrap_or_default is necessary for the user to setup ahead of time what the window should be
-            // if not we'll regress on this
+            // If the user has added a window-bundle resource, we should spawn that as as the
+            // primary window. If not, we need to spawn a default WindowBundle,
+            // hence the `unwrap_or_default()` here.
             let window_bundle = app
                 .world
                 .remove_resource::<WindowBundle>()
@@ -150,6 +143,7 @@ impl Plugin for WindowPlugin {
 #[derive(Debug, Hash, PartialEq, Eq, Clone, SystemLabel)]
 pub struct ModifiesWindows;
 
+/// Defines the specific conditions the application should exit on
 #[derive(Clone)]
 pub enum ExitCondition {
     /// Close application when the primary window is closed
@@ -165,5 +159,6 @@ pub enum ExitCondition {
 /// This resource is allowed to not exist and should be handled gracefully if it doesn't.
 #[derive(Debug, Resource, Clone, Reflect)]
 pub struct PrimaryWindow {
+    /// Window which is currently the primary window.
     pub window: Entity,
 }

crates/bevy_window/src/system.rs

@@ -22,7 +22,8 @@ pub fn exit_on_all_closed(mut app_exit_events: EventWriter<AppExit>, windows: Qu
 /// Exit the application when the primary window has been closed
 ///
 /// This system is added by the [`WindowPlugin`]
-// TODO: More docs
+/// 
+/// [`WindowPlugin`]: crate::WindowPlugin
 pub fn exit_on_primary_closed(
     mut app_exit_events: EventWriter<AppExit>,
     primary_window: Option<Res<PrimaryWindow>>,
@@ -33,9 +34,9 @@ pub fn exit_on_primary_closed(
             for window in window_close.iter() {
                 warn!(
                     "primary_window: {:?}, closed: {:?}",
-                    primary_window.window, window.entity
+                    primary_window.window, window.window
                 );
-                if primary_window.window == window.entity {
+                if primary_window.window == window.window {
                     // Primary window has been closed
                     app_exit_events.send(AppExit);
                 }
@@ -60,7 +61,7 @@ pub fn close_when_requested(
 ) {
     for event in closed.iter() {
         window_closed.send(WindowClosed {
-            entity: event.entity,
+            window: event.window,
         });
     }
 }
@@ -79,7 +80,7 @@ pub fn close_on_esc(
         }
 
         if input.just_pressed(KeyCode::Escape) {
-            window_closed.send(WindowClosed { entity });
+            window_closed.send(WindowClosed { window: entity });
         }
     }
 }