Enum amethyst_input::InputEvent

source ·

pub enum InputEvent<T> {
Show 18 variants    KeyPressed {
        key_code: VirtualKeyCode,
        scancode: u32,
    },
    KeyReleased {
        key_code: VirtualKeyCode,
        scancode: u32,
    },
    KeyTyped(char),
    MouseButtonPressed(MouseButton),
    MouseButtonReleased(MouseButton),
    ButtonPressed(Button),
    ButtonReleased(Button),
    CursorMoved {
        delta_x: f64,
        delta_y: f64,
    },
    MouseMoved {
        delta_x: f64,
        delta_y: f64,
    },
    MouseWheelMoved(ScrollDirection),
    ControllerAxisMoved {
        which: u32,
        axis: ControllerAxis,
        value: f64,
    },
    ControllerButtonPressed {
        which: u32,
        button: ControllerButton,
    },
    ControllerButtonReleased {
        which: u32,
        button: ControllerButton,
    },
    ControllerConnected {
        which: u32,
    },
    ControllerDisconnected {
        which: u32,
    },
    ActionPressed(T),
    ActionReleased(T),
    ActionWheelMoved(T),
}

Expand description

Events generated by the input system

Type parameter T is the type assigned to your Actions for your InputBundle or InputHandler.

Variants

`KeyPressed`

Fields

key_code: VirtualKeyCode

The VirtualKeyCode, used for semantic info. i.e. “W” was pressed

scancode: u32

The scancode, used for positional info. i.e. The third key on the first row was pressed.

A key was pressed down, sent exactly once per key press.

`KeyReleased`

Fields

key_code: VirtualKeyCode

The VirtualKeyCode, used for semantic info. i.e. “W” was released

scancode: u32

The scancode, used for positional info. i.e. The third key on the first row was released.

A key was released, sent exactly once per key release.

`KeyTyped(char)`

A unicode character was received by the window. Good for typing.

`MouseButtonPressed(MouseButton)`

A mouse button was pressed down, sent exactly once per press.

`MouseButtonReleased(MouseButton)`

A mouse button was released, sent exactly once per release.

`ButtonPressed(Button)`

A button was pressed.

`ButtonReleased(Button)`

A button was released.

`CursorMoved`

Fields

delta_x: f64

The amount the cursor moved horizontally in pixels.

delta_y: f64

The amount the cursor moved vertically in pixels.

The mouse pointer moved on screen

`MouseMoved`

Fields

delta_x: f64

The amount the mouse moved horizontally.

delta_y: f64

The amount the mouse moved vertically.

The mouse device moved. Use this for any use of the mouse that doesn’t involve a standard mouse pointer.

`MouseWheelMoved(ScrollDirection)`

The mousewheel was moved in either direction

`ControllerAxisMoved`

Fields

which: u32

The id for the controller whose axis moved.

axis: ControllerAxis

The axis that moved on the controller.

value: f64

The amount that the axis moved.

A controller Axis was moved.

`ControllerButtonPressed`

Fields

which: u32

The id for the controller whose button was pressed.

button: ControllerButton

The button that was pressed.

A controller button was pressed.

`ControllerButtonReleased`

Fields

which: u32

The id for the controller whose button was released.

button: ControllerButton

The button that was released.

A controller button was released.

`ControllerConnected`

Fields

which: u32

The id for the controller connected.

New controller was connected.

`ControllerDisconnected`

Fields

which: u32

The id for the controller disconnected.

Controller was disconnected, it’s id might be reused later.

`ActionPressed(T)`

The associated action had one of its keys pressed.

`ActionReleased(T)`

The associated action had one of its keys released.

`ActionWheelMoved(T)`

The associated action has its mouse wheel moved.

Trait Implementations

source

impl<T: Clone> Clone for InputEvent<T>

source

fn clone(&self) -> InputEvent<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<T: Debug> Debug for InputEvent<T>

source

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

Formats the value using the given formatter. Read more

source

impl<'de, T> Deserialize<'de> for InputEvent<T>where
T: Deserialize<'de>,

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl<T> Serialize for InputEvent<T>where
T: Serialize,

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for InputEvent<T>where
T: RefUnwindSafe,

impl<T> Send for InputEvent<T>where
T: Send,

impl<T> Sync for InputEvent<T>where
T: Sync,

impl<T> Unpin for InputEvent<T>where
T: Unpin,

impl<T> UnwindSafe for InputEvent<T>where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Any for Twhere
T: Any,

fn get_type_id(&self) -> TypeId

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Enum amethyst_input::InputEvent

Variants

KeyPressed

Fields

KeyReleased

Fields

KeyTyped(char)

MouseButtonPressed(MouseButton)

MouseButtonReleased(MouseButton)

ButtonPressed(Button)

ButtonReleased(Button)

CursorMoved

Fields

MouseMoved

Fields

MouseWheelMoved(ScrollDirection)

ControllerAxisMoved

Fields

ControllerButtonPressed

Fields

ControllerButtonReleased

Fields

ControllerConnected

Fields

ControllerDisconnected

Fields

ActionPressed(T)

ActionReleased(T)

ActionWheelMoved(T)

Trait Implementations

impl<T: Clone> Clone for InputEvent<T>

fn clone(&self) -> InputEvent<T>

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

impl<T: Debug> Debug for InputEvent<T>

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

impl<'de, T> Deserialize<'de> for InputEvent<T>where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl<T> Serialize for InputEvent<T>where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Auto Trait Implementations

impl<T> RefUnwindSafe for InputEvent<T>where T: RefUnwindSafe,

impl<T> Send for InputEvent<T>where T: Send,

impl<T> Sync for InputEvent<T>where T: Sync,

impl<T> Unpin for InputEvent<T>where T: Unpin,

impl<T> UnwindSafe for InputEvent<T>where T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Any for Twhere T: Any,

fn get_type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

`KeyPressed`

`KeyReleased`

`KeyTyped(char)`

`MouseButtonPressed(MouseButton)`

`MouseButtonReleased(MouseButton)`

`ButtonPressed(Button)`

`ButtonReleased(Button)`

`CursorMoved`

`MouseMoved`

`MouseWheelMoved(ScrollDirection)`

`ControllerAxisMoved`

`ControllerButtonPressed`

`ControllerButtonReleased`

`ControllerConnected`

`ControllerDisconnected`

`ActionPressed(T)`

`ActionReleased(T)`

`ActionWheelMoved(T)`

impl<'de, T> Deserialize<'de> for InputEvent<T>where
T: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

impl<T> Serialize for InputEvent<T>where
T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

impl<T> RefUnwindSafe for InputEvent<T>where
T: RefUnwindSafe,

impl<T> Send for InputEvent<T>where
T: Send,

impl<T> Sync for InputEvent<T>where
T: Sync,

impl<T> Unpin for InputEvent<T>where
T: Unpin,

impl<T> UnwindSafe for InputEvent<T>where
T: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Any for Twhere
T: Any,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,

impl<T> Event for Twhere
T: 'static + Send + Sync,

impl<T> Resource for Twhere
T: Any + Send + Sync,