pub struct EventLoopBuilder<T: 'static> { /* private fields */ }
Expand description

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.

Implementations§

source§

impl EventLoopBuilder<()>

source

pub fn new() -> Self

Start building a new event loop.

source§

impl<T> EventLoopBuilder<T>

source

pub fn with_user_event() -> Self

Start building a new event loop, with the given type as the user event type.

source

pub fn build(&mut self) -> EventLoop<T>

Builds a new event loop.

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

Attempting to create the event loop on a different thread, or multiple event loops in the same application, 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.

Calling this function will result in display backend initialisation.

Platform-specific
  • Linux: Backend type can be controlled 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 that fails, will fall back on X11. If this variable is set with any other value, winit will panic.
  • Android: Must be configured with an AndroidApp from android_main() by calling .with_android_app(app) before calling .build().

Trait Implementations§

source§

impl<T: Default + 'static> Default for EventLoopBuilder<T>

source§

fn default() -> EventLoopBuilder<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for EventLoopBuilder<T>where T: RefUnwindSafe,

§

impl<T> Send for EventLoopBuilder<T>where T: Send,

§

impl<T> Sync for EventLoopBuilder<T>where T: Sync,

§

impl<T> Unpin for EventLoopBuilder<T>where T: Unpin,

§

impl<T> UnwindSafe for EventLoopBuilder<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.