devela::_dep::sdl3::sys::gamepad

Struct SDL_GamepadButton

#[repr(transparent)]
pub struct SDL_GamepadButton(pub i32);
Available on crate feature dep_sdl3 only.
Expand description

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 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 constantGlobal constantDescription
INVALIDSDL_GAMEPAD_BUTTON_INVALID
SOUTHSDL_GAMEPAD_BUTTON_SOUTHBottom face button (e.g. Xbox A button)
EASTSDL_GAMEPAD_BUTTON_EASTRight face button (e.g. Xbox B button)
WESTSDL_GAMEPAD_BUTTON_WESTLeft face button (e.g. Xbox X button)
NORTHSDL_GAMEPAD_BUTTON_NORTHTop face button (e.g. Xbox Y button)
BACKSDL_GAMEPAD_BUTTON_BACK
GUIDESDL_GAMEPAD_BUTTON_GUIDE
STARTSDL_GAMEPAD_BUTTON_START
LEFT_STICKSDL_GAMEPAD_BUTTON_LEFT_STICK
RIGHT_STICKSDL_GAMEPAD_BUTTON_RIGHT_STICK
LEFT_SHOULDERSDL_GAMEPAD_BUTTON_LEFT_SHOULDER
RIGHT_SHOULDERSDL_GAMEPAD_BUTTON_RIGHT_SHOULDER
DPAD_UPSDL_GAMEPAD_BUTTON_DPAD_UP
DPAD_DOWNSDL_GAMEPAD_BUTTON_DPAD_DOWN
DPAD_LEFTSDL_GAMEPAD_BUTTON_DPAD_LEFT
DPAD_RIGHTSDL_GAMEPAD_BUTTON_DPAD_RIGHT
MISC1SDL_GAMEPAD_BUTTON_MISC1Additional 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_PADDLE1SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1)
LEFT_PADDLE1SDL_GAMEPAD_BUTTON_LEFT_PADDLE1Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3)
RIGHT_PADDLE2SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2)
LEFT_PADDLE2SDL_GAMEPAD_BUTTON_LEFT_PADDLE2Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4)
TOUCHPADSDL_GAMEPAD_BUTTON_TOUCHPADPS4/PS5 touchpad button
MISC2SDL_GAMEPAD_BUTTON_MISC2Additional button
MISC3SDL_GAMEPAD_BUTTON_MISC3Additional button
MISC4SDL_GAMEPAD_BUTTON_MISC4Additional button
MISC5SDL_GAMEPAD_BUTTON_MISC5Additional button
MISC6SDL_GAMEPAD_BUTTON_MISC6Additional button
COUNTSDL_GAMEPAD_BUTTON_COUNT

Tuple Fields§

§0: i32

Implementations§

§

impl SDL_GamepadButton

pub const INVALID: SDL_GamepadButton

pub const SOUTH: SDL_GamepadButton

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

pub const EAST: SDL_GamepadButton

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

pub const WEST: SDL_GamepadButton

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

pub const NORTH: SDL_GamepadButton

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

pub const BACK: SDL_GamepadButton

pub const GUIDE: SDL_GamepadButton

pub const START: SDL_GamepadButton

pub const LEFT_STICK: SDL_GamepadButton

pub const RIGHT_STICK: SDL_GamepadButton

pub const LEFT_SHOULDER: SDL_GamepadButton

pub const RIGHT_SHOULDER: SDL_GamepadButton

pub const DPAD_UP: SDL_GamepadButton

pub const DPAD_DOWN: SDL_GamepadButton

pub const DPAD_LEFT: SDL_GamepadButton

pub const DPAD_RIGHT: SDL_GamepadButton

pub const MISC1: SDL_GamepadButton

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: SDL_GamepadButton

Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1)

pub const LEFT_PADDLE1: SDL_GamepadButton

Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3)

pub const RIGHT_PADDLE2: SDL_GamepadButton

Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2)

pub const LEFT_PADDLE2: SDL_GamepadButton

Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4)

pub const TOUCHPAD: SDL_GamepadButton

PS4/PS5 touchpad button

pub const MISC2: SDL_GamepadButton

Additional button

pub const MISC3: SDL_GamepadButton

Additional button

pub const MISC4: SDL_GamepadButton

Additional button

pub const MISC5: SDL_GamepadButton

Additional button

pub const MISC6: SDL_GamepadButton

Additional button

pub const COUNT: SDL_GamepadButton

Trait Implementations§

§

impl Clone for SDL_GamepadButton

§

fn clone(&self) -> SDL_GamepadButton

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Default for SDL_GamepadButton

§

fn default() -> SDL_GamepadButton

Returns the “default value” for a type. Read more
§

impl From<SDL_GamepadButton> for i32

§

fn from(value: SDL_GamepadButton) -> i32

Converts to this type from the input type.
§

impl Hash for SDL_GamepadButton

§

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

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
§

impl Ord for SDL_GamepadButton

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
§

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 ==.
1.0.0 · 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.
§

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. Read more
1.0.0 · 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 · 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 · 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 · 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
§

impl Copy for SDL_GamepadButton

§

impl Eq for SDL_GamepadButton

§

impl StructuralPartialEq for SDL_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> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Source§

impl<T, R> Chain<R> for T
where T: ?Sized,

Source§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
Source§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
Source§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

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

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Source§

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

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

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source§

impl<T> Hook for T

Source§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
Source§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,