Struct Buttons 

pub struct Buttons(/* private fields */);

[microsoft.com] XINPUT_GAMEPAD_*

Bitmask of the device digital buttons of an Xbox 360 style gamepad.

See Also

• Xbox 360 controller: Layout (Wikipedia)

Implementations

impl Buttons

pub const fn zeroed() -> Self

Initialize to 0.

pub const fn none() -> Self

Initialize to 0.

pub const fn from_unchecked(d3d: u16) -> Self

Convert from an underlying winapi type. This is probably safe… probably…

pub const fn into_inner(self) -> u16

Convert back into an underlying winapi type.

impl Buttons

pub fn any_held(&self, buttons: Buttons) -> bool

Returns true if any button from buttons is set in self

pub fn all_held(&self, buttons: Buttons) -> bool

Returns true if all buttons from buttons are set in self

impl Buttons

pub const None: Buttons

No buttons are held.

pub const DPadUp: Buttons

Controller	Where
Xbox 360	Directional pad on the bottom left of the face
Xbox One	Directional pad on the bottom left of the face

pub const DPadDown: Buttons

Controller	Where
Xbox 360	Directional pad on the bottom left of the face
Xbox One	Directional pad on the bottom left of the face

pub const DPadLeft: Buttons

Controller	Where
Xbox 360	Directional pad on the bottom left of the face
Xbox One	Directional pad on the bottom left of the face

pub const DPadRight: Buttons

Controller	Where
Xbox 360	Directional pad on the bottom left of the face
Xbox One	Directional pad on the bottom left of the face

pub const Start: Buttons

Controller	Legend	Where
Xbox 360	Start ᐅ	Right button of the middle face cluster
Xbox One	Menu ≡	Right button of the middle face cluster

pub const Back: Buttons

Controller	Legend	Where
Xbox 360	Back ᐊ	Left button of the middle face cluster
Xbox One	View ⧉	Left button of the middle face cluster

pub const LeftThumb: Buttons

Controller	Legend	When
Xbox 360	L	Pressing the left thumbstick into the controller
Xbox One	L	Pressing the left thumbstick into the controller

pub const RightThumb: Buttons

Controller	Legend	When
Xbox 360	R	Pressing the right thumbstick into the controller
Xbox One	R	Pressing the right thumbstick into the controller

pub const LeftShoulder: Buttons

Controller	Legend	Where
Xbox 360	LB	Top left on the controller
Xbox One	LB	Top left on the controller

pub const RightShoulder: Buttons

Controller	Legend	Where
Xbox 360	RB	Top right on the controller
Xbox One	RB	Top right on the controller

pub const LeftTrigger: () = ()

❌ NOTE ❌ Not actually exposed by XInput as Buttons, see Gamepad::left_trigger instead.

Controller	Legend	Where
Xbox 360	LT	Under the top left of the controller
Xbox One	LT	Under the top left of the controller

pub const RightTrigger: () = ()

❌ NOTE ❌ Not actually available as part of Buttons, see Gamepad::right_trigger instead.

Controller	Legend	Where
Xbox 360	RT	Under the top right on the controller
Xbox One	RT	Under the top right on the controller

pub const Guide: Buttons

Available on crate feature undocumented only.

⚠️ NOTE ⚠️ This undocumented button is not returned by most APIs, being reserved for system software.

Specifically, you must use the undocumented XInputGetStateEx function (same API as XInputGetState?) to ever retrieve this value. Additionally, this is generally meant to be reserved by the system software. Windows, Steam, and other store apps all hook this globally regardless of what app/window has focus.

Controller	Legend	Where
Xbox 360	Guide	Center of the middle face cluster.
Xbox One	Xbox	Center of the middle face cluster.

Conflicting Software: Xbox Game Bar (Windows 8+)

To disable:

• Launch Xbox Game Bar from the start menu
• Open Settings (Gear icon on the right of the top menu bar)
• Under Shortcuts > Controller,
• Unselect Open Xbox Game Bar using (X) button on a controller

Conflicting Software: Steam

To disable, close Steam, or:

• Open Steam’s Settings
  • Settings after right clicking the Steam system tray icon, or
  • Steam > Settings in Steam’s menu bar
• Under Controller > Guide Button Chord Configuration:
  • Choose Browse Configs
  • Select Templates > Gamepad (inert/do-nothing template)
• Under Controller > General Controller Settings:
  • Disable Guide Button Focuses Steam

pub const A: Buttons

Typically synonymous select/accept in menus on Xbox 360 style controllers/games/console.

Controller	Legend	Where
Xbox 360	Green A	Bottom button of the right face cluster
Xbox One	A	Bottom button of the right face cluster

pub const B: Buttons

Typically synonymous back/cancel in menus on Xbox 360 style controllers/games/console.

Controller	Legend	Where
Xbox 360	Red B	Right button of the right face cluster
Xbox One	B	Right button of the right face cluster

pub const X: Buttons

Controller	Legend	Where
Xbox 360	Blue X	Left button of the right face cluster
Xbox One	X	Left button of the right face cluster

pub const Y: Buttons

Controller	Legend	Where
Xbox 360	Yellow Y	Top button of the right face cluster
Xbox One	Y	Top button of the right face cluster

Trait Implementations

impl BitOr for Buttons

type Output = Buttons

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Buttons

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for Buttons

fn clone(&self) -> Buttons

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buttons

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

Formats the value using the given formatter.

impl Default for Buttons

fn default() -> Self

Returns the “default value” for a type.

impl From<Buttons> for u16

fn from(value: Buttons) -> Self

Converts to this type from the input type.

impl Hash for Buttons

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 Buttons

fn cmp(&self, other: &Buttons) -> 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 for Buttons

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

fn partial_cmp(&self, other: &Buttons) -> 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 Zeroable for Buttons

fn zeroed() -> Self

Calls zeroed.

impl Copy for Buttons

impl Eq for Buttons

impl Pod for Buttons

impl StructuralPartialEq for Buttons