Skip to main content

GamepadButton

Enum GamepadButton 

Source
#[repr(C)]
pub enum GamepadButton {
Show 17 variants South = 0, East = 1, North = 2, West = 3, LeftBumper = 4, RightBumper = 5, LeftTrigger = 6, RightTrigger = 7, Select = 8, Start = 9, Mode = 10, LeftThumb = 11, RightThumb = 12, DPadUp = 13, DPadDown = 14, DPadLeft = 15, DPadRight = 16,
}
Expand description

A standard-layout gamepad button. Face buttons are Xbox-style by position (South = A / Cross, East = B / Circle, West = X / Square, North = Y / Triangle), so layouts stay consistent across vendors.

The discriminant order is also the bit position in GamepadState::buttons — don’t reorder without bumping the ABI.

Variants§

§

South = 0

Bottom face button (A / Cross).

§

East = 1

Right face button (B / Circle).

§

North = 2

Top face button (Y / Triangle).

§

West = 3

Left face button (X / Square).

§

LeftBumper = 4

Left shoulder button (L1 / LB).

§

RightBumper = 5

Right shoulder button (R1 / RB).

§

LeftTrigger = 6

Left trigger as a digital press (L2 / LT). Analog value: LeftZ.

§

RightTrigger = 7

Right trigger as a digital press (R2 / RT). Analog value: RightZ.

§

Select = 8

Select / Back / Share.

§

Start = 9

Start / Options / Menu.

§

Mode = 10

Vendor / guide button (Xbox / PS / Home).

§

LeftThumb = 11

Left stick click (L3).

§

RightThumb = 12

Right stick click (R3).

§

DPadUp = 13

D-pad up.

§

DPadDown = 14

D-pad down.

§

DPadLeft = 15

D-pad left.

§

DPadRight = 16

D-pad right.

Implementations§

Source§

impl GamepadButton

Source

pub fn bit(self) -> u32

This button’s bit in GamepadState::buttons.

Trait Implementations§

Source§

impl Clone for GamepadButton

Source§

fn clone(&self) -> GamepadButton

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 GamepadButton

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for GamepadButton

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for GamepadButton

Source§

fn cmp(&self, other: &GamepadButton) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for GamepadButton

Source§

fn eq(&self, other: &GamepadButton) -> 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 PartialOrd for GamepadButton

Source§

fn partial_cmp(&self, other: &GamepadButton) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for GamepadButton

Source§

impl Eq for GamepadButton

Source§

impl StructuralPartialEq for GamepadButton

Auto Trait Implementations§

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> GetHash for T
where T: Hash,

Source§

fn get_hash(&self) -> u64

Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.