diff --git a/crates/bevy_winit/src/winit_config.rs b/crates/bevy_winit/src/winit_config.rs index 78168309093fb..f2cb424ec5f44 100644 --- a/crates/bevy_winit/src/winit_config.rs +++ b/crates/bevy_winit/src/winit_config.rs @@ -28,6 +28,8 @@ impl WinitSettings { /// /// [`Reactive`](UpdateMode::Reactive) if windows have focus, /// [`ReactiveLowPower`](UpdateMode::ReactiveLowPower) otherwise. + /// + /// Use the [`EventLoopProxy`](crate::EventLoopProxy) to request a redraw from outside bevy. pub fn desktop_app() -> Self { WinitSettings { focused_mode: UpdateMode::Reactive { @@ -72,6 +74,7 @@ pub enum UpdateMode { /// - a redraw has been requested by [`RequestRedraw`](bevy_window::RequestRedraw) /// - new [window](`winit::event::WindowEvent`) or [raw input](`winit::event::DeviceEvent`) /// events have appeared + /// - a redraw has been requested with the [`EventLoopProxy`](crate::EventLoopProxy) Reactive { /// The approximate time from the start of one update to the next. /// @@ -84,6 +87,7 @@ pub enum UpdateMode { /// - `wait` time has elapsed since the previous update /// - a redraw has been requested by [`RequestRedraw`](bevy_window::RequestRedraw) /// - new [window events](`winit::event::WindowEvent`) have appeared + /// - a redraw has been requested with the [`EventLoopProxy`](crate::EventLoopProxy) /// /// **Note:** Unlike [`Reactive`](`UpdateMode::Reactive`), this mode will ignore events that /// don't come from interacting with a window, like [`MouseMotion`](winit::event::DeviceEvent::MouseMotion).