Struct sdl2::GameControllerSubsystem

pub struct GameControllerSubsystem { /* fields omitted */ }

Methods

impl GameControllerSubsystem

pub fn num_joysticks(&self) -> Result<u32, String>

Retrieve the total number of attached joysticks and controllers 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<GameController, 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_NumJoysticks 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 set_event_state(&self, state: bool)

If state is true controller events are processed, otherwise they're ignored.

pub fn event_state(&self) -> bool

Return true if controller events are processed.

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: AsRef<Path>>(
    &self,
    path: P
) -> Result<i32, AddMappingError>

Load controller input mappings from a file.

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

Load controller input mappings from a Read object.

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

Load controller input mappings from an SDL [RWops] object.

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

pub fn update(&self)

Force controller update when not using the event loop

impl GameControllerSubsystem

pub fn sdl(&self) -> Sdl

Obtain an SDL context.

Trait Implementations

impl Clone for GameControllerSubsystem

fn clone(&self) -> GameControllerSubsystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameControllerSubsystem

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

Formats the value using the given formatter.