Enum input::Input

pub enum Input {
    Press(Button),
    Release(Button),
    Move(Motion),
    Text(String),
    Resize(u32, u32),
    Focus(bool),
    Cursor(bool),
    Close(CloseArgs),
    Render(RenderArgs),
    AfterRender(AfterRenderArgs),
    Update(UpdateArgs),
    Idle(IdleArgs),
    Custom(EventId, Arc<Any + Send + Sync>),
}

Models input events.

Variants

Press(Button)

Pressed a button.

Release(Button)

Released a button.

Move(Motion)

Moved mouse cursor.

Text(String)

Text (usually from keyboard).

Resize(u32, u32)

Window got resized.

Focus(bool)

Window gained or lost focus.

Cursor(bool)

Window gained or lost cursor.

Close(CloseArgs)

Window closed.

Render(RenderArgs)

Render graphics.

AfterRender(AfterRenderArgs)

After rendering and swapping buffers.

Update(UpdateArgs)

Update the state of the application.

Idle(IdleArgs)

Do background tasks that can be done incrementally.

Custom(EventId, Arc<Any + Send + Sync>)

Custom event.

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

Trait Implementations

impl ControllerAxisEvent for Input

fn from_controller_axis_args(
    args: ControllerAxisArgs,
    _old_event: &Self
) -> Option<Self>

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 MouseCursorEvent for Input

fn from_xy(x: f64, y: f64, _old_event: &Self) -> Option<Self>

Creates a mouse cursor event.

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

Calls closure if this is a mouse cursor event.

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

Returns mouse cursor arguments.

impl MouseRelativeEvent for Input

fn from_xy(x: f64, y: f64, _old_event: &Self) -> Option<Self>

Creates a mouse relative event.

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

Calls closure if this is a mouse relative event.

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

Returns mouse relative arguments.

impl MouseScrollEvent for Input

fn from_xy(x: f64, y: f64, _old_event: &Self) -> Option<Self>

Creates a mouse scroll event.

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

Calls a closure if this is a mouse scroll event.

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

Returns mouse scroll arguments.

impl GenericEvent for Input

fn event_id(&self) -> EventId

The id of this event.

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

Calls closure with arguments

impl AfterRenderEvent for Input

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

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 CloseEvent for Input

fn from_close_args(args: &CloseArgs, _old_event: &Input) -> Option<Self>

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 CursorEvent for Input

fn from_cursor(cursor: bool, _old_event: &Self) -> Option<Self>

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 FocusEvent for Input

fn from_focused(focused: bool, _old_event: &Self) -> Option<Self>

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 IdleEvent for Input

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

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 PressEvent for Input

fn from_button(button: Button, _old_event: &Self) -> Option<Self>

Creates a press event.

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

Calls closure if this is a press event.

fn press_args(&self) -> Option<Button>

Returns press arguments.

impl ReleaseEvent for Input

fn from_button(button: Button, _old_event: &Self) -> Option<Self>

Creates a release event.

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

Calls closure if this is a release event.

fn release_args(&self) -> Option<Button>

Returns release arguments.

impl RenderEvent for Input

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

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 ResizeEvent for Input

fn from_width_height(w: u32, h: u32, _old_event: &Self) -> Option<Self>

Creates a resize event.

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

Calls closure if this is a resize event.

fn resize_args(&self) -> Option<[u32; 2]>

Returns resize arguments.

impl TextEvent for Input

fn from_text(text: &str, _old_event: &Self) -> Option<Self>

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 TouchEvent for Input

fn from_touch_args(args: &TouchArgs, _old_event: &Self) -> Option<Self>

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 UpdateEvent for Input

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

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 Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl PartialEq for Input

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Decodable for Input

fn decode<D: Decoder>(d: &mut D) -> Result<Input, D::Error>

Deserialize a value using a Decoder.

impl Encodable for Input

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

Serialize a value using an Encoder.

impl From<Motion> for Input

fn from(motion: Motion) -> Self

Performs the conversion.

impl From<RenderArgs> for Input

fn from(args: RenderArgs) -> Self

Performs the conversion.

impl From<AfterRenderArgs> for Input

fn from(args: AfterRenderArgs) -> Self

Performs the conversion.

impl From<UpdateArgs> for Input

fn from(args: UpdateArgs) -> Self

Performs the conversion.

impl From<IdleArgs> for Input

fn from(args: IdleArgs) -> Self

Performs the conversion.