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>
Available on not (wasm_platform
and target feature exception-handling
).
pub fn run<F>(self, event_handler: F) -> Result<(), EventLoopError>
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 set_control_flow()
docs on how to change the event loop’s behavior.
§Platform-specific
-
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
EventLoopExtWebSys::spawn()
1 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"
.
EventLoopExtWebSys::spawn()
is only available on WASM. ↩
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 / Web: Always returns None
.
sourcepub fn listen_device_events(&self, allowed: DeviceEvents)
pub fn listen_device_events(&self, allowed: DeviceEvents)
Change if or when DeviceEvent
s 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.
sourcepub fn set_control_flow(&self, control_flow: ControlFlow)
pub fn set_control_flow(&self, control_flow: ControlFlow)
Sets the ControlFlow
.
sourcepub fn control_flow(&self) -> ControlFlow
pub fn control_flow(&self) -> ControlFlow
Gets the current ControlFlow
.
sourcepub fn exit(&self)
pub fn exit(&self)
This exits the event loop.
See LoopExiting
.
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
) -> PumpStatus
fn pump_events<F>( &mut self, timeout: Option<Duration>, event_handler: F ) -> PumpStatus
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_on_demand<F>(&mut self, event_handler: F) -> Result<(), EventLoopError>
fn run_on_demand<F>(&mut self, event_handler: F) -> Result<(), EventLoopError>
event_handler
closure
to dispatch any window system events. Read moresource§impl<T> HasDisplayHandle for EventLoop<T>
Available on crate feature rwh_06
only.
impl<T> HasDisplayHandle for EventLoop<T>
rwh_06
only.source§fn display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>
fn display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>
source§impl<T> HasRawDisplayHandle for EventLoop<T>
Available on crate feature rwh_05
only.
impl<T> HasRawDisplayHandle for EventLoop<T>
rwh_05
only.source§fn raw_display_handle(&self) -> RawDisplayHandle
fn raw_display_handle(&self) -> RawDisplayHandle
Returns a rwh_05::RawDisplayHandle
for the event loop.
impl<T> EventLoopExtAndroid for EventLoop<T>
android_platform
only.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>where
T: UnwindSafe,
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
source§impl<T> HasRawDisplayHandle for Twhere
T: HasDisplayHandle + ?Sized,
impl<T> HasRawDisplayHandle for Twhere
T: HasDisplayHandle + ?Sized,
source§fn raw_display_handle(&self) -> Result<RawDisplayHandle, HandleError>
fn raw_display_handle(&self) -> Result<RawDisplayHandle, HandleError>
HasDisplayHandle
instead