Enum AppEvent

#[non_exhaustive]
pub enum AppEvent<A: Application> {
    PingUserInput,
    RunIdle(Box<dyn FnOnce(&mut A, Args<'_, A>) + Send + Sync>),
    RunIdleSimple(Box<dyn FnOnce() + Send + Sync>),
    User(A::UserEvent),
}

The main event type to be used with winit::EventLoop.

It is generic on the Application type.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PingUserInput

Calls ping_user_input on the main window.

RunIdle(Box<dyn FnOnce(&mut A, Args<'_, A>) + Send + Sync>)

Runs the given callback in the main loop idle step, with the regular arguments.

RunIdleSimple(Box<dyn FnOnce() + Send + Sync>)

Runs the given callback in the main loop idle step, without arguments.

User(A::UserEvent)

Sends the custom user event.

Trait Implementations

impl<A> ApplicationHandler<AppEvent<A>> for AppHandler<A>

where A: Application,

fn suspended(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has been suspended.

fn resumed(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has been resumed.

fn window_event( &mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent, )

Emitted when the OS sends an event to a winit window.

fn device_event( &mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent, )

Emitted when the OS sends an event to a device.

fn user_event(&mut self, event_loop: &ActiveEventLoop, event: AppEvent<A>)

Emitted when an event is sent from EventLoopProxy::send_event.

fn new_events(&mut self, _event_loop: &ActiveEventLoop, _cause: StartCause)

Emitted when new events arrive from the OS to be processed.

fn about_to_wait(&mut self, _event_loop: &ActiveEventLoop)

Emitted when the event loop is about to block and wait for new events.

fn exiting(&mut self, event_loop: &ActiveEventLoop)

Emitted when the event loop is being shut down.

fn memory_warning(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has received a memory warning.

impl<A: Application> Debug for AppEvent<A>

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

Formats the value using the given formatter.