Struct winit::event_loop::EventLoopBuilder

pub struct EventLoopBuilder { /* private fields */ }

Object that allows building the event loop.

This is used to make specifying options that affect the whole application easier. But note that constructing multiple event loops is not supported.

This can be created using EventLoop::builder.

Implementations

impl EventLoopBuilder

pub fn build(&mut self) -> Result<EventLoop, EventLoopError>

Builds a new event loop.

For cross-platform compatibility, the EventLoop must be created on the main thread, and only once per application.

Calling this function will result in display backend initialisation.

Panics

Attempting to create the event loop off the main 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. EventLoopBuilderExt::any_thread functions are exposed in the relevant platform module if the target platform supports creating an event loop on any thread.

Platform-specific

• Wayland/X11: to prevent running under Wayland or X11 unset WAYLAND_DISPLAY or DISPLAY respectively when building the event loop.
• Android: must be configured with an AndroidApp from android_main() by calling .with_android_app(app) before calling .build(), otherwise it’ll panic.

Trait Implementations

impl Debug for EventLoopBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EventLoopBuilder

fn default() -> EventLoopBuilder

Returns the “default value” for a type.

impl EventLoopBuilderExtWayland for EventLoopBuilder

fn with_wayland(&mut self) -> &mut Self

Force using Wayland.

fn with_any_thread(&mut self, any_thread: bool) -> &mut Self

Whether to allow the event loop to be created off of the main thread.

impl EventLoopBuilderExtX11 for EventLoopBuilder

fn with_x11(&mut self) -> &mut Self

Force using X11.

fn with_any_thread(&mut self, any_thread: bool) -> &mut Self

Whether to allow the event loop to be created off of the main thread.

impl Hash for EventLoopBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventLoopBuilder

fn eq(&self, other: &EventLoopBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EventLoopBuilder

impl StructuralPartialEq for EventLoopBuilder