Struct SDL_GamepadButton 

#[repr(transparent)]
pub struct SDL_GamepadButton(pub c_int);

The list of buttons available on a gamepad

For controllers that use a diamond pattern for the face buttons, the south/east/west/north buttons below correspond to the locations in the diamond pattern. For Xbox controllers, this would be A/B/X/Y, for Nintendo Switch controllers, this would be B/A/Y/X, for GameCube controllers this would be A/X/B/Y, for PlayStation controllers this would be Cross/Circle/Square/Triangle.

For controllers that don’t use a diamond pattern for the face buttons, the south/east/west/north buttons indicate the buttons labeled A, B, C, D, or 1, 2, 3, 4, or for controllers that aren’t labeled, they are the primary, secondary, etc. buttons.

The activate action is often the south button and the cancel action is often the east button, but in some regions this is reversed, so your game should allow remapping actions based on user preferences.

You can query the labels for the face buttons using SDL_GetGamepadButtonLabel()

Availability

This enum is available since SDL 3.2.0.

Known values (sdl3-sys)

Associated constant	Global constant	Description
INVALID	SDL_GAMEPAD_BUTTON_INVALID
SOUTH	SDL_GAMEPAD_BUTTON_SOUTH	Bottom face button (e.g. Xbox A button)
EAST	SDL_GAMEPAD_BUTTON_EAST	Right face button (e.g. Xbox B button)
WEST	SDL_GAMEPAD_BUTTON_WEST	Left face button (e.g. Xbox X button)
NORTH	SDL_GAMEPAD_BUTTON_NORTH	Top face button (e.g. Xbox Y button)
BACK	SDL_GAMEPAD_BUTTON_BACK
GUIDE	SDL_GAMEPAD_BUTTON_GUIDE
START	SDL_GAMEPAD_BUTTON_START
LEFT_STICK	SDL_GAMEPAD_BUTTON_LEFT_STICK
RIGHT_STICK	SDL_GAMEPAD_BUTTON_RIGHT_STICK
LEFT_SHOULDER	SDL_GAMEPAD_BUTTON_LEFT_SHOULDER
RIGHT_SHOULDER	SDL_GAMEPAD_BUTTON_RIGHT_SHOULDER
DPAD_UP	SDL_GAMEPAD_BUTTON_DPAD_UP
DPAD_DOWN	SDL_GAMEPAD_BUTTON_DPAD_DOWN
DPAD_LEFT	SDL_GAMEPAD_BUTTON_DPAD_LEFT
DPAD_RIGHT	SDL_GAMEPAD_BUTTON_DPAD_RIGHT
MISC1	SDL_GAMEPAD_BUTTON_MISC1	Additional button (e.g. Xbox Series X share button, PS5 microphone button, Nintendo Switch Pro capture button, Amazon Luna microphone button, Google Stadia capture button)
RIGHT_PADDLE1	SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1	Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1, DualSense Edge RB button, Right Joy-Con SR button)
LEFT_PADDLE1	SDL_GAMEPAD_BUTTON_LEFT_PADDLE1	Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3, DualSense Edge LB button, Left Joy-Con SL button)
RIGHT_PADDLE2	SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2	Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2, DualSense Edge right Fn button, Right Joy-Con SL button)
LEFT_PADDLE2	SDL_GAMEPAD_BUTTON_LEFT_PADDLE2	Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4, DualSense Edge left Fn button, Left Joy-Con SR button)
TOUCHPAD	SDL_GAMEPAD_BUTTON_TOUCHPAD	PS4/PS5 touchpad button
MISC2	SDL_GAMEPAD_BUTTON_MISC2	Additional button
MISC3	SDL_GAMEPAD_BUTTON_MISC3	Additional button (e.g. Nintendo GameCube left trigger click)
MISC4	SDL_GAMEPAD_BUTTON_MISC4	Additional button (e.g. Nintendo GameCube right trigger click)
MISC5	SDL_GAMEPAD_BUTTON_MISC5	Additional button
MISC6	SDL_GAMEPAD_BUTTON_MISC6	Additional button
COUNT	SDL_GAMEPAD_BUTTON_COUNT

Tuple Fields

0: c_int

Implementations

impl SDL_GamepadButton

pub const INVALID: Self

pub const SOUTH: Self

Bottom face button (e.g. Xbox A button)

pub const EAST: Self

Right face button (e.g. Xbox B button)

pub const WEST: Self

Left face button (e.g. Xbox X button)

pub const NORTH: Self

Top face button (e.g. Xbox Y button)

pub const BACK: Self

pub const GUIDE: Self

pub const START: Self

pub const LEFT_STICK: Self

pub const RIGHT_STICK: Self

pub const LEFT_SHOULDER: Self

pub const RIGHT_SHOULDER: Self

pub const DPAD_UP: Self

pub const DPAD_DOWN: Self

pub const DPAD_LEFT: Self

pub const DPAD_RIGHT: Self

pub const MISC1: Self

Additional button (e.g. Xbox Series X share button, PS5 microphone button, Nintendo Switch Pro capture button, Amazon Luna microphone button, Google Stadia capture button)

pub const RIGHT_PADDLE1: Self

Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1, DualSense Edge RB button, Right Joy-Con SR button)

pub const LEFT_PADDLE1: Self

Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3, DualSense Edge LB button, Left Joy-Con SL button)

pub const RIGHT_PADDLE2: Self

Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2, DualSense Edge right Fn button, Right Joy-Con SL button)

pub const LEFT_PADDLE2: Self

Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4, DualSense Edge left Fn button, Left Joy-Con SR button)

pub const TOUCHPAD: Self

PS4/PS5 touchpad button

pub const MISC2: Self

Additional button

pub const MISC3: Self

Additional button (e.g. Nintendo GameCube left trigger click)

pub const MISC4: Self

Additional button (e.g. Nintendo GameCube right trigger click)

pub const MISC5: Self

Additional button

pub const MISC6: Self

Additional button

pub const COUNT: Self

Trait Implementations

impl Clone for SDL_GamepadButton

fn clone(&self) -> SDL_GamepadButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_GamepadButton

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_GamepadButton

fn default() -> SDL_GamepadButton

Returns the “default value” for a type.

impl From<SDL_GamepadButton> for c_int

fn from(value: SDL_GamepadButton) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_GamepadButton

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_GamepadButton

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 SDL_GamepadButton

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<SDL_GamepadButton> for c_int

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

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

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

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

impl PartialEq<i32> for SDL_GamepadButton

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

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

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

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

impl PartialEq for SDL_GamepadButton

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

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

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

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

impl PartialOrd for SDL_GamepadButton

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for SDL_GamepadButton

impl Eq for SDL_GamepadButton

impl StructuralPartialEq for SDL_GamepadButton