Struct WinitEventLoop 

pub struct WinitEventLoop { /* private fields */ }

Available on crate feature backend_winit only.

Abstracted event loop of a WinitWindow.

You can register it into calloop or call dispatch_new_events periodically to receive any events.

Implementations

impl WinitEventLoop

pub fn dispatch_new_events<F>(&mut self, callback: F) -> PumpStatus

where F: FnMut(WinitEvent),

Processes new events of the underlying event loop and calls the provided callback.

You need to periodically call this function to keep the underlying event loop and WinitWindow active. Otherwise the window may not respond to user interaction.

Returns an error if the WinitWindow the window has been closed. Calling dispatch_new_events again after the WinitWindow has been closed is considered an application error and unspecified behaviour may occur.

The linked WinitGraphicsBackend will error with a lost context and should not be used anymore as well.

Trait Implementations

impl Debug for WinitEventLoop

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

Formats the value using the given formatter.

impl EventSource for WinitEventLoop

const NEEDS_EXTRA_LIFECYCLE_EVENTS: bool = true

Whether this source needs to be sent the EventSource::before_sleep and EventSource::before_handle_events notifications. These are opt-in because they require more expensive checks, and almost all sources will not need these notifications

type Event = WinitEvent

The type of events generated by your source.

type Metadata = ()

Some metadata of your event source

type Ret = ()

The return type of the user callback

type Error = Error

The error type returned from process_events() (not the user callback!).

fn before_sleep(&mut self) -> Result<Option<(Readiness, Token)>>

Notification that a single poll is about to begin

fn process_events<F>( &mut self, _readiness: Readiness, _token: Token, callback: F, ) -> Result<PostAction, Self::Error>

where F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Process any relevant events

fn register( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Register yourself to this poll instance

fn reregister( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

fn before_handle_events(&mut self, events: EventIterator<'_>)

Notification that polling is complete, and EventSource::process_events will be called with the given events for this source. The iterator may be empty, which indicates that no events were generated for this source