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

Correct RequestRedraw documentation (#8640)

Browse Source 
# Objective

- Since the `RequestRedraw` event triggers the bevy app to run `update`
in `bevy_app::app::App`, the documentation should state that all the
windows in the application and its sub-apps are going to get redrawn,
rather than a single window.

## Solution

- Change `RequestRedraw` documentation in `bevy_window` to mention every
window.
This commit is contained in:
lelo 2023-05-22 22:16:56 -04:00 committed by GitHub
parent 335afbf77a
commit c475a2a954
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/bevy_window/src/event.rs
View File

@ -24,9 +24,8 @@ pub struct WindowResized {
pub height: f32, pub height: f32,
} }
// TODO: This would redraw all windows ? If yes, update docs to reflect this /// An event that indicates all of the application's windows should be redrawn,
/// An event that indicates the window should redraw, even if its control flow is set to `Wait` and /// even if their control flow is set to `Wait` and there have been no window events.
/// there have been no window events.
#[derive(Debug, Clone, PartialEq, Eq, Reflect, FromReflect)] #[derive(Debug, Clone, PartialEq, Eq, Reflect, FromReflect)]
#[reflect(Debug, PartialEq)] #[reflect(Debug, PartialEq)]
#[cfg_attr( #[cfg_attr(