Struct winit::event_loop::EventLoop
source · pub struct EventLoop<T: 'static> { /* private fields */ }Expand description
Provides a way to retrieve events from the system and from the windows that were registered to the events loop.
An EventLoop can be seen more or less as a “context”. Calling EventLoop::new
initializes everything that will be required to create windows. For example on Linux creating
an event loop opens a connection to the X or Wayland server.
To wake up an EventLoop from a another thread, see the EventLoopProxy docs.
Note that this cannot be shared across threads (due to platform-dependant logic
forbidding it), as such it is neither Send nor Sync. If you need cross-thread access, the
Window created from this can be sent to an other thread, and the
EventLoopProxy allows you to wake up an EventLoop from another thread.
Implementations§
source§impl EventLoop<()>
impl EventLoop<()>
sourcepub fn new() -> Result<EventLoop<()>, EventLoopError>
pub fn new() -> Result<EventLoop<()>, EventLoopError>
Alias for EventLoopBuilder::new().build().
source§impl<T> EventLoop<T>
impl<T> EventLoop<T>
pub fn with_user_event() -> Result<EventLoop<T>, EventLoopError>
EventLoopBuilder::<T>::with_user_event().build() instead.sourcepub fn run<F>(self, event_handler: F) -> Result<(), EventLoopError>where
F: FnMut(Event<T>, &EventLoopWindowTarget<T>, &mut ControlFlow),
Available on not (wasm_platform and target feature exception-handling).
pub fn run<F>(self, event_handler: F) -> Result<(), EventLoopError>where F: FnMut(Event<T>, &EventLoopWindowTarget<T>, &mut ControlFlow),
wasm_platform and target feature exception-handling).Runs the event loop in the calling thread and calls the given event_handler closure
to dispatch any pending events.
Since the closure is 'static, it must be a move closure if it needs to
access any data from the calling context.
See the ControlFlow docs for information on how changes to &mut ControlFlow impact the
event loop’s behavior.
Platform-specific
-
X11 / Wayland: The program terminates with exit code 1 if the display server disconnects.
-
iOS: Will never return to the caller and so values not passed to this function will not be dropped before the process exits.
-
Web: Will act as if it never returns to the caller by throwing a Javascript exception (that Rust doesn’t see) that will also mean that the rest of the function is never executed and any values not passed to this function will not be dropped.
Web applications are recommended to use
spawn()instead ofrun()to avoid the need for the Javascript exception trick, and to make it clearer that the event loop runs asynchronously (via the browser’s own, internal, event loop) and doesn’t block the current thread of execution like it does on other platforms.This function won’t be available with
target_feature = "exception-handling".
sourcepub fn create_proxy(&self) -> EventLoopProxy<T>
pub fn create_proxy(&self) -> EventLoopProxy<T>
Creates an EventLoopProxy that can be used to dispatch user events to the main event loop.
Methods from Deref<Target = EventLoopWindowTarget<T>>§
sourcepub fn available_monitors(&self) -> impl Iterator<Item = MonitorHandle>
pub fn available_monitors(&self) -> impl Iterator<Item = MonitorHandle>
Returns the list of all the monitors available on the system.
sourcepub fn primary_monitor(&self) -> Option<MonitorHandle>
pub fn primary_monitor(&self) -> Option<MonitorHandle>
Returns the primary monitor of the system.
Returns None if it can’t identify any monitor as a primary one.
Platform-specific
Wayland: Always returns None.
sourcepub fn listen_device_events(&self, _allowed: DeviceEvents)
pub fn listen_device_events(&self, _allowed: DeviceEvents)
Change if or when DeviceEvents are captured.
Since the DeviceEvent capture can lead to high CPU usage for unfocused windows, winit
will ignore them by default for unfocused windows on Linux/BSD. This method allows changing
this at runtime to explicitly capture them again.
Platform-specific
- Wayland / macOS / iOS / Android / Orbital: Unsupported.
Trait Implementations§
source§impl<T> Deref for EventLoop<T>
impl<T> Deref for EventLoop<T>
§type Target = EventLoopWindowTarget<T>
type Target = EventLoopWindowTarget<T>
source§fn deref(&self) -> &EventLoopWindowTarget<T>
fn deref(&self) -> &EventLoopWindowTarget<T>
source§impl<T> EventLoopExtPumpEvents for EventLoop<T>
Available on windows_platform or macos_platform or android_platform or x11_platform or wayland_platform only.
impl<T> EventLoopExtPumpEvents for EventLoop<T>
windows_platform or macos_platform or android_platform or x11_platform or wayland_platform only.§type UserEvent = T
type UserEvent = T
Event::UserEvent.source§fn pump_events<F>(
&mut self,
timeout: Option<Duration>,
event_handler: F
) -> PumpStatuswhere
F: FnMut(Event<Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
fn pump_events<F>( &mut self, timeout: Option<Duration>, event_handler: F ) -> PumpStatuswhere F: FnMut(Event<Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
EventLoop to check for and dispatch pending events. Read moresource§impl<T> EventLoopExtRunOnDemand for EventLoop<T>
Available on windows_platform or macos_platform or android_platform or x11_platform or wayland_platform only.
impl<T> EventLoopExtRunOnDemand for EventLoop<T>
windows_platform or macos_platform or android_platform or x11_platform or wayland_platform only.§type UserEvent = T
type UserEvent = T
Event::UserEvent.source§fn run_ondemand<F>(&mut self, event_handler: F) -> Result<(), EventLoopError>where
F: FnMut(Event<Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
fn run_ondemand<F>(&mut self, event_handler: F) -> Result<(), EventLoopError>where F: FnMut(Event<Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
event_handler closure
to dispatch any window system events. Read moresource§impl<T> HasRawDisplayHandle for EventLoop<T>
impl<T> HasRawDisplayHandle for EventLoop<T>
source§fn raw_display_handle(&self) -> RawDisplayHandle
fn raw_display_handle(&self) -> RawDisplayHandle
Returns a raw_window_handle::RawDisplayHandle for the event loop.
Auto Trait Implementations§
impl<T> !RefUnwindSafe for EventLoop<T>
impl<T> !Send for EventLoop<T>
impl<T> !Sync for EventLoop<T>
impl<T> Unpin for EventLoop<T>where T: Unpin,
impl<T> !UnwindSafe for EventLoop<T>
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.