Enum gamepads::Button

pub enum Button {
    ActionDown,
    ActionRight,
    ActionLeft,
    ActionUp,
    FrontLeftUpper,
    FrontRightUpper,
    FrontLeftLower,
    FrontRightLower,
    LeftCenterCluster,
    RightCenterCluster,
    LeftStick,
    RightStick,
    DPadUp,
    DPadDown,
    DPadLeft,
    DPadRight,
    Mode,
}

A button on a gamepad.

Check for the current state of button presses on a gamepad using one of:

• Gamepad::all_currently_pressed()
• Gamepad::all_just_pressed()
• Gamepad::is_currently_pressed()
• Gamepad::is_just_pressed()

Different platforms call the buttons different things, see the below pictures for an overview, as well as the individual button documentations for a comparison.

Playstation

Switch

Xbox

W3C Gamepad API standard gamepad layout:

Variants

ActionDown

Lowermost button in right cluster

• Playstation: X/Cross button
• Switch: B button
• Xbox: A button
• Gamepad API: buttons[0] / Bottom button in right cluster

ActionRight

Rightmost button in right cluster

• Gamepad API: buttons[1] / Right button in right cluster
• Playstation: O/Circle button
• Switch: A
• Xbox: B

ActionLeft

Leftmost button in right cluster

• Gamepad API: buttons[2] / Left button in right cluster
• Playstation: □/Square
• Switch: Y
• Xbox: X

ActionUp

Topmost button in right cluster

• Gamepad API: buttons[3] / Top button in right cluster
• Playstation: △/Triangle
• Switch: X
• Xbox: Y

FrontLeftUpper

Top left front button

• Gamepad API: buttons[4] / Top left front button
• Playstation: L1
• Switch: L
• Xbox: LB (Left Bumper)

FrontRightUpper

Top right front button

• Gamepad API: buttons[5] / Top right front button
• Playstation: R1
• Switch: R
• Xbox: RB (Right Bumper)

FrontLeftLower

Bottom left front button

• Gamepad API: buttons[6] / Bottom left front button
• Playstation: L2
• Switch: ZL
• Xbox: LT (Left Trigger)

FrontRightLower

Bottom right front button

• Gamepad API: buttons[7] / Bottom right front button
• Playstation: R2
• Switch: ZR
• Xbox: RT (Right Trigger)

LeftCenterCluster

Left button in center cluster - select/back

• Gamepad API: buttons[8] / Left button in center cluster
• Playstation: SELECT
• Switch: Capture
• Xbox: RT (Right Trigger)

RightCenterCluster

Right button in center cluster - start/forward.

• Gamepad API: buttons[9] / Right button in center cluster
• Playstation: Start
• Switch: Home
• Xbox: Start

LeftStick

Left stick pressed button.

RightStick

Right stick pressed button.

DPadUp

D-pad up button.

DPadDown

D-pad down button.

DPadLeft

D-pad left button.

DPadRight

D-pad right button.

Mode

Mode button.

• Gamepad API: buttons[16] / Center button in center cluster

Implementations

impl Button

pub fn all() -> impl Iterator<Item = Self>

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Button

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

Formats the value using the given formatter.

impl Hash for Button

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Button

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Button> for Button

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Button

impl Eq for Button

impl StructuralEq for Button

impl StructuralPartialEq for Button