Struct beryllium::Controller

#[repr(transparent)]
pub struct Controller<'sdl> { /* fields omitted */ }

Handle to a window on the screen.

Methods

impl<'sdl> Controller<'sdl>

pub fn mapping_string(&self) -> Option<String>

Obtains the mapping string, if available.

pub fn name(&self) -> Option<String>

The implementation defined name for this controller.

pub fn is_attached(&self) -> bool

Checks that the controller is currently connected.

pub fn axis(&self, axis: ControllerAxis) -> i16

Gives the axis value of the specified axis.

• Sticks: negative to positive
• Triggers: zero to positive

Also gives 0 on failure. You could call get_error if you want.

pub fn button(&self, button: ControllerButton) -> bool

Gives if the given button is pressed.

Note that this returns false for not-pressed but also if there's some sort of error. You can call get_error if you really want.

pub fn joystick_id(&self) -> Result<JoystickID, String>

Attempts to get the joystick ID of this controller.

Trait Implementations

impl<'sdl> Drop for Controller<'sdl>

fn drop(&mut self)

Executes the destructor for this type.

impl<'sdl> Debug for Controller<'sdl>

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

Formats the value using the given formatter.