Enum amethyst_input::Axis

pub enum Axis {
    Emulated {
        pos: Button,
        neg: Button,
    },
    Controller {
        controller_id: u32,
        axis: ControllerAxis,
        invert: bool,
        dead_zone: f64,
    },
}

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

Variants

Emulated

Fields

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 emulated analogue axis made up of pair of digital inputs, like W and S keyboard buttons or DPadUp and DPadDown controller buttons.

Controller

Fields

controller_id: u32

A number representing 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 an analogue axis of a controller.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Axis

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Axis> for Axis

fn eq(&self, other: &Axis) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Axis

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Axis