Struct rich_sdl2_rust::event::joystick::Joystick

pub struct Joystick { /* private fields */ }

A physical joystick device manages its states, input devices and power levels.

Implementations

impl Joystick

pub fn from_id(id: JoystickId<'_>) -> Option<Self>

Constructs from JoystickId if it is valid.

pub fn instance_id(&self) -> JoystickId<'_>

Returns the instance id JoystickId.

pub fn power_level(&self) -> PowerLevel

Returns the power level of the joystick.

pub fn guid(&self) -> Guid

Returns the GUID of the joystick.

pub fn name(&self) -> Cow<'_, str>

Returns the name of the joystick.

pub fn enable(&self)

Turns the joystick into enable.

pub fn disable(&self)

Turns the joystick into disable.

pub fn is_enabled(&self) -> bool

Returns whether the joystick is enabled.

pub fn axes(&self) -> Axes<'_>

Returns axes Axes that the joystick has.

pub fn axis(&self, index: InputIndex) -> Option<Axis<'_>>

Returns an axis of index if it exists.

pub fn trackballs(&self) -> Trackballs<'_>

Returns trackballs Trackballs that the joystick has.

pub fn trackball(&self, index: InputIndex) -> Option<Trackball<'_>>

Returns a trackball of index if it exists.

pub fn buttons(&self) -> Buttons<'_>

Returns buttons Buttons that the joystick has.

pub fn button(&self, index: InputIndex) -> Option<Button<'_>>

Returns a button of index if it exists.

pub fn hats(&self) -> Hats<'_>

Returns hats Hats that the joystick has.

pub fn hat(&self, index: InputIndex) -> Option<Hat<'_>>

Returns a hat of index if it exists.

Trait Implementations

impl Clone for Joystick

fn clone(&self) -> Joystick

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Joystick

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

Formats the value using the given formatter.

impl From<GameController> for Joystick

fn from(gc: GameController) -> Self

Converts to this type from the input type.

impl PartialEq for Joystick

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Joystick

impl StructuralPartialEq for Joystick