Struct winit::EventsLoop

pub struct EventsLoop { /* fields omitted */ }

Provides a way to retrieve events from the system and from the windows that were registered to the events loop.

An EventsLoop can be seen more or less as a "context". Calling EventsLoop::new() initializes everything that will be required to create windows. For example on Linux creating an events loop opens a connection to the X or Wayland server.

To wake up an EventsLoop from a another thread, see the EventsLoopProxy docs.

Note that the EventsLoop cannot be shared accross threads (due to platform-dependant logic forbiding it), as such it is neither Send nor Sync. If you need cross-thread access, the Window created from this EventsLoop can be sent to an other thread, and the EventsLoopProxy allows you to wakeup an EventsLoop from an other thread.

Methods

impl EventsLoop

pub fn new() -> EventsLoop

Builds a new events loop.

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.

Important traits for AvailableMonitorsIter

impl Iterator for AvailableMonitorsIter type Item = MonitorId;

pub fn get_available_monitors(&self) -> AvailableMonitorsIter

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

pub fn get_primary_monitor(&self) -> MonitorId

Returns the primary monitor of the system.

pub fn poll_events<F>(&mut self, callback: F) where
    F: FnMut(Event), 

Fetches all the events that are pending, calls the callback function for each of them, and returns.

pub fn run_forever<F>(&mut self, callback: F) where
    F: FnMut(Event) -> ControlFlow, 

Calls callback every time an event is received. If no event is available, sleeps the current thread and waits for an event. If the callback returns ControlFlow::Break then run_forever will immediately return.

Danger!

The callback is run after every event, so if its execution time is non-trivial the event queue may not empty at a sufficient rate. Rendering in the callback with vsync enabled will cause significant lag.

pub fn create_proxy(&self) -> EventsLoopProxy

Creates an EventsLoopProxy that can be used to wake up the EventsLoop from another thread.

Trait Implementations

impl EventsLoopExt for EventsLoop

fn new_x11() -> Result<Self, XNotSupported>

Builds a new EventsLoop that is forced to use X11.

fn new_wayland() -> Self

Builds a new EventsLoop that is forced to use Wayland.

fn is_wayland(&self) -> bool

True if the EventsLoop uses Wayland.

fn is_x11(&self) -> bool

True if the EventsLoop uses X11.

fn get_wayland_display(&self) -> Option<*mut c_void>

Returns a pointer to the wl_display object of wayland that is used by this EventsLoop.

impl Debug for EventsLoop

fn fmt(&self, fmtr: &mut Formatter) -> Result

Formats the value using the given formatter.