Struct bevy_winit::WinitSettings
source · pub struct WinitSettings {
pub return_from_run: bool,
pub focused_mode: UpdateMode,
pub unfocused_mode: UpdateMode,
}
Expand description
A resource for configuring usage of the winit
library.
Fields§
§return_from_run: bool
Configures winit
to return control to the caller after exiting the
event loop, enabling App::run()
to return.
By default, return_from_run
is false
and Bevy
will use winit
’s
EventLoop::run()
to initiate the event loop.
EventLoop::run()
will never return but will terminate the process after the event loop exits.
Setting return_from_run
to true
will cause Bevy
to use winit
’s
EventLoopExtRunReturn::run_return()
instead which is strongly discouraged by the winit
authors.
Supported platforms
This feature is only available on the following desktop target_os
configurations:
windows
, macos
, linux
, dragonfly
, freebsd
, netbsd
, and openbsd
.
Setting return_from_run
to true
on
unsupported platforms will cause App::run()
to panic!
focused_mode: UpdateMode
Configures how the winit event loop updates while the window is focused.
unfocused_mode: UpdateMode
Configures how the winit event loop updates while the window is not focused.
Implementations§
source§impl WinitSettings
impl WinitSettings
sourcepub fn desktop_app() -> Self
pub fn desktop_app() -> Self
Configure winit with common settings for a desktop application.
sourcepub fn update_mode(&self, focused: bool) -> &UpdateMode
pub fn update_mode(&self, focused: bool) -> &UpdateMode
Gets the configured UpdateMode
depending on whether the window is focused or not
Trait Implementations§
source§impl Debug for WinitSettings
impl Debug for WinitSettings
source§impl Default for WinitSettings
impl Default for WinitSettings
impl Resource for WinitSettingswhere Self: Send + Sync + 'static,
Auto Trait Implementations§
impl RefUnwindSafe for WinitSettings
impl Send for WinitSettings
impl Sync for WinitSettings
impl Unpin for WinitSettings
impl UnwindSafe for WinitSettings
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World