Enum PadKind 

pub enum PadKind {
    Xbox,
    PlayStation,
    PlayStation4,
    Nintendo,
    Playdate,
    Generic,
}

Who made a pad, which decides the Confirm / Cancel swap here and the button names shown on screen (ticket 0220).

Variants

Xbox

A Microsoft pad.

PlayStation

A Sony pad other than a PS4 one (a PS5 pad).

PlayStation4

A Sony PS4 pad: named as a PlayStation pad, except its left centre button is Share.

Nintendo

A Nintendo pad (Switch Pro controller, Joy-Cons).

Playdate

The Playdate’s own buttons (game ADR-0070): the D-pad, A and B. Its backend reports A at the binding position East and B at West (targets/playdate.ron, ADR-0008 §1), with no swap, so a game binds them in its keymap’s targets."playdate" table.

Generic

Anything else, or a pad that doesn’t say. Treated like an Xbox pad.

Implementations

impl PadKind

pub const ALL: [PadKind; 6]

Every kind.

pub fn from_ids(vendor: u16, product: u16) -> Self

The kind of a pad from its USB vendor and product ids; unknown vendors (and 0, “not reported”) are Generic. The product only matters for Sony, to tell a PS4 pad apart.

pub fn position(self, button: Button) -> Button

The position bindings use for the button physically at button on this kind of pad: on a Nintendo pad the bottom and right face buttons swap (so its right button, labelled A, is South and confirms by default); every other button, and every other pad, is unchanged.

pub fn button_name(self, button: Button) -> &'static str

What help text calls the button at binding position button on this kind of pad (docs/design/controls.md, Button names on screen): Xbox letters (also on generic pads), Sony’s shapes, or Nintendo’s letters (a PS4 pad says Share where later Sony pads say Create). The Playdate’s A is East and its B is West, as printed on it; every other name is the Xbox one, its D-pad’s and its crank’s among them, but South’s, which is the X that leaves free: A would name a button its A doesn’t press. It has none of the other buttons (their actions move to chords and menus in tickets 1034 and 1035). The only place buttons get their names.

pub fn chord_name(self, chord: ButtonChord, join: &str) -> String

What help text calls chord on this kind of pad: its button’s name, or a button chord’s two names with join between them (A+B, B+← with +), in the chord’s order.

Trait Implementations

impl Clone for PadKind

fn clone(&self) -> PadKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PadKind

impl Debug for PadKind

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

Formats the value using the given formatter.

impl Default for PadKind

fn default() -> PadKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PadKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PadKind

impl Hash for PadKind

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 PadKind

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PadKind

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PadKind