Struct winit::event_loop::EventLoop[][src]

pub struct EventLoop<T: 'static> {
    pub(crate) event_loop: EventLoop<T>,
    pub(crate) _marker: PhantomData<*mut ()>,
}
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.

Fields

event_loop: EventLoop<T>_marker: PhantomData<*mut ()>

Implementations

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.

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.

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.

Creates an EventLoopProxy that can be used to dispatch user events to the main event loop.

Methods from Deref<Target = EventLoopWindowTarget<T>>

Returns the list of all the monitors available on the system.

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

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

A type provided by the user that can be passed through Event::UserEvent.

Initializes the winit event loop. Read more

Builds a new EventLoop on any thread. Read more

Builds a new X11 EventLoop on any thread. Read more

Builds a new Wayland EventLoop on any thread. Read more

Builds a new EventLoop that is forced to use X11. Read more

Builds a new EventLoop that is forced to use Wayland. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.