Struct GamepadState

Source

#[repr(C)]pub struct GamepadState {
    pub id: GamepadId,
    pub connected: bool,
    pub buttons: u32,
    pub left_stick_x: f32,
    pub left_stick_y: f32,
    pub right_stick_x: f32,
    pub right_stick_y: f32,
    pub left_z: f32,
    pub right_z: f32,
}

Expand description

Snapshot of one gamepad’s state. Buttons are a bitset (bit n = the GamepadButton with discriminant n); axes are explicit fields. All POD / Copy, so it crosses the FFI by value.

Fields§

§id: GamepadId

Which pad this snapshot is for.

§connected: bool

false once the pad disconnects (the manager keeps the last slot so a callback can observe the disconnect).

§buttons: u32

Pressed-button bitset — bit n set ⇔ the GamepadButton with discriminant n is held. Read via GamepadState::is_pressed.

§left_stick_x: f32

Left stick X in [-1, 1].

§left_stick_y: f32

Left stick Y in [-1, 1].

§right_stick_x: f32

Right stick X in [-1, 1].

§right_stick_y: f32

Right stick Y in [-1, 1].

§left_z: f32

Left trigger pressure in [0, 1].

§right_z: f32

Right trigger pressure in [0, 1].

Implementations§

Source §

impl GamepadState

Source

pub fn empty(id: GamepadId) -> GamepadState

An empty (disconnected) state for id — all buttons up, axes zero.

Source

pub fn is_pressed(&self, button: GamepadButton) -> bool

Whether button is currently held.

Source

pub fn axis(&self, axis: GamepadAxis) -> f32

The current value of axis (sticks [-1, 1], triggers [0, 1]).

Trait Implementations§

Source §

impl Clone for GamepadState

Source §

fn clone(&self) -> GamepadState

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for GamepadState

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for GamepadState

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl Copy for GamepadState

Source §

impl StructuralPartialEq for GamepadState

Auto Trait Implementations§

§

impl UnwindSafe for GamepadState

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

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.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §