Struct GameController

pub struct GameController { /* private fields */ }

Available on crate feature dep_sdl2 only.

Wrapper around the SDL_GameController object

Implementations

impl GameController

pub fn subsystem(&self) -> &GameControllerSubsystem

pub fn name(&self) -> String

Return the name of the controller or an empty string if no name is found.

pub fn mapping(&self) -> String

Return a String describing the controller’s button and axis mappings

pub fn attached(&self) -> bool

Return true if the controller has been opened and currently connected.

pub fn instance_id(&self) -> u32

Return the joystick instance id of this controller

pub fn vendor_id(&self) -> Option<u16>

Return the USB vendor ID of an opened controller, if available.

pub fn product_id(&self) -> Option<u16>

Return the USB product ID of an opened controller, if available.

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

Get the position of the given axis

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

Returns true if button is pressed.

pub fn set_rumble( &mut self, low_frequency_rumble: u16, high_frequency_rumble: u16, duration_ms: u32, ) -> Result<(), IntegerOrSdlError>

Set the rumble motors to their specified intensities, if supported. Automatically resets back to zero after duration_ms milliseconds have passed.

Notes

The value range for the intensities is 0 to 0xFFFF.

Do not use std::u32::MAX or similar for duration_ms if you want the rumble effect to keep playing for a long time, as this results in the effect ending immediately after starting due to an overflow. Use some smaller, “huge enough” number instead.

pub fn set_rumble_triggers( &mut self, left_rumble: u16, right_rumble: u16, duration_ms: u32, ) -> Result<(), IntegerOrSdlError>

Start a rumble effect in the game controller’s triggers.

pub fn has_led(&self) -> bool

Query whether a game controller has an LED.

pub fn has_rumble(&self) -> bool

Query whether a game controller has rumble support.

pub fn has_rumble_triggers(&self) -> bool

Query whether a game controller has rumble support on triggers.

pub fn set_led( &mut self, red: u8, green: u8, blue: u8, ) -> Result<(), IntegerOrSdlError>

Update a game controller’s LED color.

pub fn send_effect(&mut self, data: &[u8]) -> Result<(), String>

Send a controller specific effect packet.

Trait Implementations

impl Drop for GameController

fn drop(&mut self)

Executes the destructor for this type.