Enum tao::event::Event [−][src]
pub enum Event<'a, T: 'static> { NewEvents(StartCause), WindowEvent { window_id: WindowId, event: WindowEvent<'a>, }, DeviceEvent { device_id: DeviceId, event: DeviceEvent, }, UserEvent(T), MenuEvent { menu_id: MenuId, origin: MenuType, }, Suspended, Resumed, MainEventsCleared, RedrawRequested(WindowId), RedrawEventsCleared, LoopDestroyed, }
Expand description
Describes a generic event.
See the module-level docs for more information on the event loop manages each event.
Variants
NewEvents(StartCause)
Expand description
Emitted when new events arrive from the OS to be processed.
This event type is useful as a place to put code that should be done before you start
processing events, such as updating frame timing information for benchmarking or checking
the StartCause
to see if a timer set by
ControlFlow::WaitUntil
has elapsed.
Expand description
Emitted when the OS sends an event to a tao window.
Show fields
Fields of WindowEvent
window_id: WindowId
event: WindowEvent<'a>
Expand description
Emitted when the OS sends an event to a device.
Show fields
Fields of DeviceEvent
device_id: DeviceId
event: DeviceEvent
Expand description
Emitted when an event is sent from EventLoopProxy::send_event
Expand description
Emitted when a menu has been clicked. There are two types of menu event. One comes from the menu bar, the other comes from the status bar.
Show fields
Fields of MenuEvent
origin: MenuType
Expand description
Emitted when the application has been suspended.
Expand description
Emitted when the application has been resumed.
Expand description
Emitted when all of the event loop’s input events have been processed and redraw processing is about to begin.
This event is useful as a place to put your code that should be run after all
state-changing events have been handled and you want to do stuff (updating state, performing
calculations, etc) that happens as the “main body” of your event loop. If your program only draws
graphics when something changes, it’s usually better to do it in response to
Event::RedrawRequested
, which gets emitted
immediately after this event. Programs that draw graphics continuously, like most games,
can render here unconditionally for simplicity.
RedrawRequested(WindowId)
Expand description
Emitted after MainEventsCleared
when a window should be redrawn.
This gets triggered in two scenarios:
- The OS has performed an operation that’s invalidated the window’s contents (such as resizing the window).
- The application has explicitly requested a redraw via
Window::request_redraw
.
During each iteration of the event loop, Tao will aggregate duplicate redraw requests into a single event, to help avoid duplicating rendering work.
Mainly of interest to applications with mostly-static graphics that avoid redrawing unless something changes, like most non-game GUIs.
Expand description
Emitted after all RedrawRequested
events have been processed and control flow is about to
be taken away from the program. If there are no RedrawRequested
events, it is emitted
immediately after MainEventsCleared
.
This event is useful for doing any cleanup or bookkeeping work after all the rendering tasks have been completed.
Expand description
Emitted when the event loop is being shut down.
This is irreversable - if this event is emitted, it is guaranteed to be the last event that gets emitted. You generally want to treat this as an “do on quit” event.
Implementations
Trait Implementations
impl<'a, T: 'static> StructuralPartialEq for Event<'a, T>
[src]
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for Event<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<'a, T> Send for Event<'a, T> where
T: Send,
T: Send,
impl<'a, T> Sync for Event<'a, T> where
T: Sync,
T: Sync,
impl<'a, T> Unpin for Event<'a, T> where
T: Unpin,
T: Unpin,
impl<'a, T> !UnwindSafe for Event<'a, T>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more