Enum GamepadButton

#[repr(i32)]
pub enum GamepadButton {
    Unknown = 0,
    DpadLeft = 1,
    DpadRight = 2,
    DpadUp = 3,
    DpadDown = 4,
    South = 5,
    East = 6,
    North = 7,
    West = 8,
    ShoulderLeft = 9,
    ShoulderRight = 10,
    JoystickLeft = 11,
    JoystickRight = 12,
    Start = 13,
    Select = 14,
    Logo = 15,
    Share = 16,
    C = 17,
    Z = 18,
    TriggerLeft = 19,
    TriggerRight = 20,
}

Variants

Unknown = 0

DpadLeft = 1

DpadRight = 2

DpadUp = 3

DpadDown = 4

South = 5

X on a DualShock/DualSense, A on an Xbox gamepad, and B on a Nintendo gamepad.

East = 6

North = 7

West = 8

ShoulderLeft = 9

The right and left shoulder buttons, usually called L1 and R1.

ShoulderRight = 10

JoystickLeft = 11

The left and right joystick buttons, usually called L3 and R3.

JoystickRight = 12

Start = 13

Assorted buttons on the face of the gamepad.

Select = 14

Logo = 15

Share = 16

C = 17

Occasionally, gamepads will have another two buttons next to the NESW buttons.

Z = 18

TriggerLeft = 19

Very rarely, gamepads will have another set of buttons rather than triggers.

TriggerRight = 20

Implementations

impl GamepadButton

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of GamepadButton.

pub fn from_i32(value: i32) -> Option<GamepadButton>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a GamepadButton, or None if value is not a valid variant.

impl GamepadButton

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<GamepadButton>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for GamepadButton

fn clone(&self) -> GamepadButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for GamepadButton

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<GamepadButton, Error>

impl Debug for GamepadButton

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

Formats the value using the given formatter.

impl Default for GamepadButton

fn default() -> GamepadButton

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for GamepadButton

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: GamepadButton) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<GamepadButton, Error>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: GamepadButton, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<GamepadButton, Error>

Read a rust value from a buffer, received over the FFI in serialized form.

impl Hash for GamepadButton

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

where __H: Hasher,

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<UT> Lift<UT> for GamepadButton

type FfiType = <GamepadButton as FfiConverter<UT>>::FfiType

fn try_lift( v: <GamepadButton as Lift<UT>>::FfiType, ) -> Result<GamepadButton, Error>

fn try_read(buf: &mut &[u8]) -> Result<GamepadButton, Error>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for GamepadButton

type LiftType = GamepadButton

impl<UT> LiftReturn<UT> for GamepadButton

type ReturnType = <GamepadButton as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return( v: <GamepadButton as LiftReturn<UT>>::ReturnType, ) -> Result<GamepadButton, Error>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for GamepadButton

type FfiType = <GamepadButton as FfiConverter<UT>>::FfiType

fn lower(obj: GamepadButton) -> <GamepadButton as Lower<UT>>::FfiType

fn write(obj: GamepadButton, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for GamepadButton

fn lower_error(obj: GamepadButton) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for GamepadButton

type ReturnType = <GamepadButton as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return( v: GamepadButton, ) -> Result<<GamepadButton as LowerReturn<UT>>::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Ord for GamepadButton

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

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

fn partial_cmp(&self, other: &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 TryFrom<i32> for GamepadButton

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<GamepadButton, UnknownEnumValue>

Performs the conversion.

impl<UT> TypeId<UT> for GamepadButton

const TYPE_ID_META: MetadataBuffer

impl Copy for GamepadButton

impl Eq for GamepadButton

impl StructuralPartialEq for GamepadButton