[][src]Enum amethyst_input::Axis

pub enum Axis {
    Emulated {
        pos: Button,
        neg: Button,
    Controller {
        controller_id: u32,
        axis: ControllerAxis,
        invert: bool,
        dead_zone: f64,
    Mouse {
        axis: MouseAxis,
        over_extendable: bool,
        radius: f32,
    MouseWheel {
        horizontal: bool,

Represents any input represented by a float value from -1 to 1. Retrieve the value of this with axis_value.



Represents an emulated analogue axis made up of pair of digital inputs, like W and S keyboard buttons or DPadUp and DPadDown controller buttons.

Fields of Emulated

pos: Button

Positive button, when pressed down axis value will return 1 if neg is not pressed down.

neg: Button

Negative button, when pressed down axis value will return -1 if pos is not pressed down.


Represents an analogue axis of a controller.

Fields of Controller

controller_id: u32

A number representing a specific controller, assigned and reused in order of connection.

axis: ControllerAxis

The axis being bound

invert: bool

Whether or not to multiply the axis value by -1.

dead_zone: f64

Treat input values from -dead_zone to dead_zone as 0, linearly interpolate remaining ranges.


Represents a mouse as a 2D input device

Fields of Mouse

axis: MouseAxis

The axis being bound

over_extendable: bool

Should the API be allowed to return values outside [-1..1]?

radius: f32

Zone to which the movement is relative


Represents the wheel on a PC mouse.

Fields of MouseWheel

horizontal: bool

If this value is true then this axis is for the horizontal mouse wheel rather than the vertical mouse wheel.

You almost always want this false.


Represents multiple input alternatives. Allows to bind more than one input to a single axis.

Trait Implementations

impl Clone for Axis[src]

impl Debug for Axis[src]

impl<'de> Deserialize<'de> for Axis[src]

impl PartialEq<Axis> for Axis[src]

impl Serialize for Axis[src]

impl StructuralPartialEq for Axis[src]

Auto Trait Implementations

impl RefUnwindSafe for Axis

impl Send for Axis

impl Sync for Axis

impl Unpin for Axis

impl UnwindSafe for Axis

Blanket Implementations

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

impl<T> Any for T where
    T: Any

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Config for T where
    T: for<'a> Deserialize<'a> + Serialize

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

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

impl<T> From<T> for T[src]

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

impl<T> Resource for T where
    T: Any + Send + Sync

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SetParameter for T

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,