Enum piston::Event

pub enum Event {
    Input(Input, Option<u32>),
    Loop(Loop),
    Custom(EventId, Arc<dyn Any + 'static + Send + Sync>, Option<u32>),
}

Models all events.

Variants

Input(Input, Option<u32>)

Input events.

Time stamp is ignored when comparing input events for equality and order.

Loop(Loop)

Events that commonly used by event loops.

Custom(EventId, Arc<dyn Any + 'static + Send + Sync>, Option<u32>)

Custom event.

When comparing two custom events for equality, they always return false.

When comparing partial order of two custom events, the event ids are checked and if they are equal it returns None.

Time stamp is ignored both when comparing custom events for equality and order.

Trait Implementations

impl MouseScrollEvent for Event

fn from_pos(pos: [f64; 2], old_event: &Event) -> Option<Event>

Creates a mouse scroll event.

fn mouse_scroll<U, F>(&self, f: F) -> Option<U> where
    F: FnMut([f64; 2]) -> U, 

Calls a closure if this is a mouse scroll event.

fn mouse_scroll_args(&self) -> Option<[f64; 2]>

Returns mouse scroll arguments.

impl TouchEvent for Event

fn from_touch_args(args: &TouchArgs, old_event: &Event) -> Option<Event>

Creates a touch event.

fn touch<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&TouchArgs) -> U, 

Calls closure if this is a touch event.

fn touch_args(&self) -> Option<TouchArgs>

Returns touch arguments.

impl CloseEvent for Event

fn from_close_args(args: &CloseArgs, old_event: &Event) -> Option<Event>

Creates a close event from arguments.

fn close<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&CloseArgs) -> U, 

Calls closure if this is a close event.

fn close_args(&self) -> Option<CloseArgs>

Returns close arguments.

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl TextEvent for Event

fn from_text(text: &str, old_event: &Event) -> Option<Event>

Creates a text event.

fn text<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&str) -> U, 

Calls closure if this is a text event.

fn text_args(&self) -> Option<String>

Returns text arguments.

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Event

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

Formats the value using the given formatter.

impl ButtonEvent for Event

fn from_button_args(args: ButtonArgs, old_event: &Event) -> Option<Event>

Creates a button event.

fn button<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(ButtonArgs) -> U, 

Calls closure if this is a button event.

fn button_args(&self) -> Option<ButtonArgs>

Returns button arguments.

impl CursorEvent for Event

fn from_cursor(cursor: bool, old_event: &Event) -> Option<Event>

Creates a cursor event.

fn cursor<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(bool) -> U, 

Calls closure if this is a cursor event.

fn cursor_args(&self) -> Option<bool>

Returns cursor arguments.

impl UpdateEvent for Event

fn from_update_args(args: &UpdateArgs, _old_event: &Event) -> Option<Event>

Creates an update event.

fn update<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&UpdateArgs) -> U, 

Calls closure if this is an update event.

fn from_dt(dt: f64, old_event: &Self) -> Option<Self>

Creates an update event with delta time.

fn update_args(&self) -> Option<UpdateArgs>

Returns update arguments.

impl RenderEvent for Event

fn from_render_args(args: &RenderArgs, _old_event: &Event) -> Option<Event>

Creates a render event.

fn render<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&RenderArgs) -> U, 

Calls closure if this is a render event.

fn render_args(&self) -> Option<RenderArgs>

Returns render arguments.

impl ControllerAxisEvent for Event

fn from_controller_axis_args(
    args: ControllerAxisArgs,
    old_event: &Event
) -> Option<Event>

Creates a controller axis event.

fn controller_axis<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(ControllerAxisArgs) -> U, 

Calls closure if this is a controller axis event.

fn controller_axis_args(&self) -> Option<ControllerAxisArgs>

Returns controller axis arguments.

impl PartialOrd<Event> for Event

fn partial_cmp(&self, other: &Event) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl MouseRelativeEvent for Event

fn from_pos(pos: [f64; 2], old_event: &Event) -> Option<Event>

Creates a mouse relative event.

fn mouse_relative<U, F>(&self, f: F) -> Option<U> where
    F: FnMut([f64; 2]) -> U, 

Calls closure if this is a mouse relative event.

fn mouse_relative_args(&self) -> Option<[f64; 2]>

Returns mouse relative arguments.

impl GenericEvent for Event

fn event_id(&self) -> EventId

The id of this event.

fn with_args<F, U>(&'a self, f: F) -> U where
    F: FnMut(&(dyn Any + 'static)) -> U, 

Calls closure with arguments

fn time_stamp(&self) -> Option<u32>

Gets the time stamp of this event.

impl FocusEvent for Event

fn from_focused(focused: bool, old_event: &Event) -> Option<Event>

Creates a focus event.

fn focus<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(bool) -> U, 

Calls closure if this is a focus event.

fn focus_args(&self) -> Option<bool>

Returns focus arguments.

impl ResizeEvent for Event

fn from_resize_args(args: &ResizeArgs, old_event: &Event) -> Option<Event>

Creates a resize event.

fn resize<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&ResizeArgs) -> U, 

Calls closure if this is a resize event.

fn resize_args(&self) -> Option<ResizeArgs>

Returns resize arguments.

impl Into<Option<Loop>> for Event

fn into(self) -> Option<Loop>

Performs the conversion.

impl Into<Option<Input>> for Event

fn into(self) -> Option<Input>

Performs the conversion.

impl From<Loop> for Event

fn from(l: Loop) -> Event

Performs the conversion.

impl From<RenderArgs> for Event

fn from(args: RenderArgs) -> Event

Performs the conversion.

impl<T> From<T> for Event where
    Input: From<T>, 

fn from(args: T) -> Event

Performs the conversion.

impl From<UpdateArgs> for Event

fn from(args: UpdateArgs) -> Event

Performs the conversion.

impl From<IdleArgs> for Event

fn from(args: IdleArgs) -> Event

Performs the conversion.

impl From<AfterRenderArgs> for Event

fn from(args: AfterRenderArgs) -> Event

Performs the conversion.

impl<T> From<(T, Option<u32>)> for Event where
    Input: From<T>, 

fn from(args: (T, Option<u32>)) -> Event

Performs the conversion.

impl AfterRenderEvent for Event

fn from_after_render_args(
    args: &AfterRenderArgs,
    _old_event: &Event
) -> Option<Event>

Creates an after render event.

fn after_render<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&AfterRenderArgs) -> U, 

Calls closure if this is an after render event.

fn after_render_args(&self) -> Option<AfterRenderArgs>

Returns after render arguments.

impl IdleEvent for Event

fn from_idle_args(args: &IdleArgs, _old_event: &Event) -> Option<Event>

Creates an idle event.

fn idle<U, F>(&self, f: F) -> Option<U> where
    F: FnMut(&IdleArgs) -> U, 

Calls closure if this is an idle event.

fn from_dt(dt: f64, old_event: &Self) -> Option<Self>

Creates an update event with delta time.

fn idle_args(&self) -> Option<IdleArgs>

Returns idle arguments.

impl MouseCursorEvent for Event

fn from_pos(pos: [f64; 2], old_event: &Event) -> Option<Event>

Creates a mouse cursor event.

fn mouse_cursor<U, F>(&self, f: F) -> Option<U> where
    F: FnMut([f64; 2]) -> U, 

Calls closure if this is a mouse cursor event.

fn mouse_cursor_args(&self) -> Option<[f64; 2]>

Returns mouse cursor arguments.