Struct luminvent_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 the EventLoop
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 EventLoop
can be sent to an other thread, and the
EventLoopProxy
allows you to wake up an EventLoop
from another thread.
Implementations
sourceimpl EventLoop<()>
impl EventLoop<()>
sourcepub fn new() -> EventLoop<()>
pub fn new() -> EventLoop<()>
Builds a new event loop with a ()
as the user event type.
For cross-platform compatibility, the EventLoop
must be created on the main thread.
Attempting to create the event loop on a different thread will panic. This restriction isn’t
strictly necessary on all platforms, but is imposed to eliminate any nasty surprises when
porting to platforms that require it. EventLoopExt::new_any_thread
functions are exposed
in the relevant platform
module if the target platform supports creating an event loop on
any thread.
Usage will result in display backend initialisation, this can be controlled on linux
using an environment variable WINIT_UNIX_BACKEND
. Legal values are x11
and wayland
.
If it is not set, winit will try to connect to a wayland connection, and if it fails will
fallback on x11. If this variable is set with any other value, winit will panic.
Platform-specific
- iOS: Can only be called on the main thread.
sourceimpl<T> EventLoop<T>
impl<T> EventLoop<T>
sourcepub fn with_user_event() -> EventLoop<T>
pub fn with_user_event() -> EventLoop<T>
Builds a new event loop.
All caveats documented in EventLoop::new
apply to this function.
Platform-specific
- iOS: Can only be called on the main thread.
sourcepub fn run<F>(self, event_handler: F) -> ! where
F: 'static + FnMut(Event<'_, T>, &EventLoopWindowTarget<T>, &mut ControlFlow),
pub fn run<F>(self, event_handler: F) -> ! where
F: 'static + FnMut(Event<'_, T>, &EventLoopWindowTarget<T>, &mut ControlFlow),
Hijacks the calling thread and initializes the winit event loop with the provided
closure. 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.
Any values not passed to this function will not be dropped.
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
.
Trait Implementations
sourceimpl<T> Deref for EventLoop<T>
impl<T> Deref for EventLoop<T>
type Target = EventLoopWindowTarget<T>
type Target = EventLoopWindowTarget<T>
The resulting type after dereferencing.
sourcefn deref(&self) -> &EventLoopWindowTarget<T>
fn deref(&self) -> &EventLoopWindowTarget<T>
Dereferences the value.
sourceimpl<T> EventLoopExtRunReturn for EventLoop<T>
impl<T> EventLoopExtRunReturn for EventLoop<T>
type UserEvent = T
type UserEvent = T
A type provided by the user that can be passed through Event::UserEvent
.
sourcefn run_return<F>(&mut self, event_handler: F) where
F: FnMut(Event<'_, Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
fn run_return<F>(&mut self, event_handler: F) where
F: FnMut(Event<'_, Self::UserEvent>, &EventLoopWindowTarget<Self::UserEvent>, &mut ControlFlow),
Initializes the winit
event loop. Read more
sourceimpl<T> EventLoopExtUnix for EventLoop<T>
impl<T> EventLoopExtUnix for EventLoop<T>
sourcefn new_any_thread() -> Self
fn new_any_thread() -> Self
Builds a new EventLoop
on any thread. Read more
sourcefn new_x11_any_thread() -> Result<Self, XNotSupported>
fn new_x11_any_thread() -> Result<Self, XNotSupported>
Builds a new X11 EventLoop
on any thread. Read more
sourcefn new_wayland_any_thread() -> Self
fn new_wayland_any_thread() -> Self
Builds a new Wayland EventLoop
on any thread. Read more
sourcefn new_x11() -> Result<Self, XNotSupported>
fn new_x11() -> Result<Self, XNotSupported>
Builds a new EventLoop
that is forced to use X11. Read more
sourcefn new_wayland() -> Self
fn new_wayland() -> Self
Builds a new EventLoop
that is forced to use Wayland. Read more
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more