Struct GamepadSubsystem

pub struct GamepadSubsystem { /* private fields */ }

Available on crate feature dep_sdl3 only.

Implementations

impl GamepadSubsystem

pub fn num_gamepads(&self) -> Result<u32, Error>

Retrieve the total number of attached gamepads identified by SDL.

pub fn is_game_controller(&self, joystick_index: u32) -> bool

Return true if the joystick at index joystick_index is a game controller.

pub fn open(&self, joystick_index: u32) -> Result<Gamepad, IntegerOrSdlError>

Attempt to open the controller at index joystick_index and return it. Controller IDs are the same as joystick IDs and the maximum number can be retrieved using the SDL_GetJoysticks function.

pub fn name_for_index( &self, joystick_index: u32, ) -> Result<String, IntegerOrSdlError>

Return the name of the controller at index joystick_index.

pub fn add_mapping( &self, mapping: &str, ) -> Result<MappingStatus, AddMappingError>

Add a new controller input mapping from a mapping string.

pub fn load_mappings<P>(&self, path: P) -> Result<i32, AddMappingError>

where P: AsRef<Path>,

Load controller input mappings from a file.

pub fn load_mappings_from_read<R>( &self, read: &mut R, ) -> Result<i32, AddMappingError>

where R: Read,

Load controller input mappings from a Read object.

pub fn load_mappings_from_rw( &self, rw: IOStream<'_>, ) -> Result<i32, AddMappingError>

Load controller input mappings from an SDL IOStream object.

pub fn mapping_for_guid(&self, guid: Guid) -> Result<String, Error>

pub fn update(&self)

Force controller update when not using the event loop

Trait Implementations

impl Clone for GamepadSubsystem

fn clone(&self) -> GamepadSubsystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GamepadSubsystem

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

Formats the value using the given formatter.

impl Drop for GamepadSubsystem

fn drop(&mut self)

Executes the destructor for this type.