SDL_gamecontroller.c File Reference

#include "../SDL_internal.h"
#include "SDL_events.h"
#include "SDL_hints.h"
#include "SDL_timer.h"
#include "SDL_sysjoystick.h"
#include "SDL_joystick_c.h"
#include "SDL_gamecontrollerdb.h"
#include "usb_ids.h"
#include "../events/SDL_events_c.h"

Include dependency graph for SDL_gamecontroller.c:

Go to the source code of this file.

Data Structures
struct	SDL_ExtendedGameControllerBind
struct	ControllerMapping_t
struct	SDL_GameController
struct	SDL_vidpid_list

Macros
#define	SDL_MINIMUM_GUIDE_BUTTON_DELAY_MS   250
#define	SDL_CONTROLLER_PLATFORM_FIELD   "platform:"
#define	SDL_CONTROLLER_HINT_FIELD   "hint:"
#define	SDL_CONTROLLER_SDKGE_FIELD   "sdk>=:"
#define	SDL_CONTROLLER_SDKLE_FIELD   "sdk<=:"

Enumerations
enum	SDL_ControllerMappingPriority {   SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT ,   SDL_CONTROLLER_MAPPING_PRIORITY_API ,   SDL_CONTROLLER_MAPPING_PRIORITY_USER }

Functions
static void	SDL_LoadVIDPIDListFromHint (const char *hint, SDL_vidpid_list *list)
static void	SDL_GameControllerIgnoreDevicesChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
static void	SDL_GameControllerIgnoreDevicesExceptChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
static ControllerMapping_t *	SDL_PrivateAddMappingForGUID (SDL_JoystickGUID jGUID, const char *mappingString, SDL_bool *existing, SDL_ControllerMappingPriority priority)
static int	SDL_PrivateGameControllerAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis, Sint16 value)
static int	SDL_PrivateGameControllerButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button, Uint8 state)
static void	UpdateEventsForDeviceRemoval (int device_index)
static SDL_bool	HasSameOutput (SDL_ExtendedGameControllerBind *a, SDL_ExtendedGameControllerBind *b)
static void	ResetOutput (SDL_GameController *gamecontroller, SDL_ExtendedGameControllerBind *bind)
static void	HandleJoystickAxis (SDL_GameController *gamecontroller, int axis, int value)
static void	HandleJoystickButton (SDL_GameController *gamecontroller, int button, Uint8 state)
static void	HandleJoystickHat (SDL_GameController *gamecontroller, int hat, Uint8 value)
static void	RecenterGameController (SDL_GameController *gamecontroller)
static int	SDL_GameControllerEventWatcher (void *userdata, SDL_Event *event)
static ControllerMapping_t *	SDL_CreateMappingForHIDAPIController (SDL_JoystickGUID guid)
static ControllerMapping_t *	SDL_CreateMappingForRAWINPUTController (SDL_JoystickGUID guid)
static ControllerMapping_t *	SDL_PrivateGetControllerMappingForGUID (SDL_JoystickGUID guid, SDL_bool exact_match)
SDL_GameControllerAxis	SDL_GameControllerGetAxisFromString (const char *pchString)
const char *	SDL_GameControllerGetStringForAxis (SDL_GameControllerAxis axis)
SDL_GameControllerButton	SDL_GameControllerGetButtonFromString (const char *pchString)
const char *	SDL_GameControllerGetStringForButton (SDL_GameControllerButton axis)
static void	SDL_PrivateGameControllerParseElement (SDL_GameController *gamecontroller, const char *szGameButton, const char *szJoystickButton)
static void	SDL_PrivateGameControllerParseControllerConfigString (SDL_GameController *gamecontroller, const char *pchString)
static void	SDL_PrivateLoadButtonMapping (SDL_GameController *gamecontroller, const char *pchName, const char *pchMapping)
static char *	SDL_PrivateGetControllerGUIDFromMappingString (const char *pMapping)
static char *	SDL_PrivateGetControllerNameFromMappingString (const char *pMapping)
static char *	SDL_PrivateGetControllerMappingFromMappingString (const char *pMapping)
static void	SDL_PrivateGameControllerRefreshMapping (ControllerMapping_t *pControllerMapping)
static ControllerMapping_t *	SDL_PrivateGetControllerMappingForNameAndGUID (const char *name, SDL_JoystickGUID guid)
static void	SDL_PrivateAppendToMappingString (char *mapping_string, size_t mapping_string_len, const char *input_name, SDL_InputMapping *mapping)
static ControllerMapping_t *	SDL_PrivateGenerateAutomaticControllerMapping (const char *name, SDL_JoystickGUID guid, SDL_GamepadMapping *raw_map)
static ControllerMapping_t *	SDL_PrivateGetControllerMapping (int device_index)
int	SDL_GameControllerAddMappingsFromRW (SDL_RWops *rw, int freerw)
static int	SDL_PrivateGameControllerAddMapping (const char *mappingString, SDL_ControllerMappingPriority priority)
int	SDL_GameControllerAddMapping (const char *mappingString)
int	SDL_GameControllerNumMappings (void)
char *	SDL_GameControllerMappingForIndex (int mapping_index)
char *	SDL_GameControllerMappingForGUID (SDL_JoystickGUID guid)
char *	SDL_GameControllerMapping (SDL_GameController *gamecontroller)
static void	SDL_GameControllerLoadHints ()
static SDL_bool	SDL_GetControllerMappingFilePath (char *path, size_t size)
int	SDL_GameControllerInitMappings (void)
int	SDL_GameControllerInit (void)
const char *	SDL_GameControllerNameForIndex (int device_index)
SDL_GameControllerType	SDL_GameControllerTypeForIndex (int joystick_index)
char *	SDL_GameControllerMappingForDeviceIndex (int joystick_index)
SDL_bool	SDL_IsGameControllerNameAndGUID (const char *name, SDL_JoystickGUID guid)
SDL_bool	SDL_IsGameController (int device_index)
SDL_bool	SDL_ShouldIgnoreGameController (const char *name, SDL_JoystickGUID guid)
SDL_GameController *	SDL_GameControllerOpen (int device_index)
void	SDL_GameControllerUpdate (void)
SDL_bool	SDL_GameControllerHasAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
Sint16	SDL_GameControllerGetAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
SDL_bool	SDL_GameControllerHasButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
Uint8	SDL_GameControllerGetButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
int	SDL_GameControllerGetNumTouchpads (SDL_GameController *gamecontroller)
int	SDL_GameControllerGetNumTouchpadFingers (SDL_GameController *gamecontroller, int touchpad)
int	SDL_GameControllerGetTouchpadFinger (SDL_GameController *gamecontroller, int touchpad, int finger, Uint8 *state, float *x, float *y, float *pressure)
SDL_bool	SDL_GameControllerHasSensor (SDL_GameController *gamecontroller, SDL_SensorType type)
int	SDL_GameControllerSetSensorEnabled (SDL_GameController *gamecontroller, SDL_SensorType type, SDL_bool enabled)
SDL_bool	SDL_GameControllerIsSensorEnabled (SDL_GameController *gamecontroller, SDL_SensorType type)
int	SDL_GameControllerGetSensorData (SDL_GameController *gamecontroller, SDL_SensorType type, float *data, int num_values)
const char *	SDL_GameControllerName (SDL_GameController *gamecontroller)
SDL_GameControllerType	SDL_GameControllerGetType (SDL_GameController *gamecontroller)
int	SDL_GameControllerGetPlayerIndex (SDL_GameController *gamecontroller)
void	SDL_GameControllerSetPlayerIndex (SDL_GameController *gamecontroller, int player_index)
Uint16	SDL_GameControllerGetVendor (SDL_GameController *gamecontroller)
Uint16	SDL_GameControllerGetProduct (SDL_GameController *gamecontroller)
Uint16	SDL_GameControllerGetProductVersion (SDL_GameController *gamecontroller)
const char *	SDL_GameControllerGetSerial (SDL_GameController *gamecontroller)
SDL_bool	SDL_GameControllerGetAttached (SDL_GameController *gamecontroller)
SDL_Joystick *	SDL_GameControllerGetJoystick (SDL_GameController *gamecontroller)
SDL_GameController *	SDL_GameControllerFromInstanceID (SDL_JoystickID joyid)
SDL_GameController *	SDL_GameControllerFromPlayerIndex (int player_index)
SDL_GameControllerButtonBind	SDL_GameControllerGetBindForAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
SDL_GameControllerButtonBind	SDL_GameControllerGetBindForButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
int	SDL_GameControllerRumble (SDL_GameController *gamecontroller, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
int	SDL_GameControllerRumbleTriggers (SDL_GameController *gamecontroller, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
SDL_bool	SDL_GameControllerHasLED (SDL_GameController *gamecontroller)
int	SDL_GameControllerSetLED (SDL_GameController *gamecontroller, Uint8 red, Uint8 green, Uint8 blue)
void	SDL_GameControllerClose (SDL_GameController *gamecontroller)
void	SDL_GameControllerQuit (void)
void	SDL_GameControllerQuitMappings (void)
int	SDL_GameControllerEventState (int state)
void	SDL_GameControllerHandleDelayedGuideButton (SDL_Joystick *joystick)

Variables
static SDL_GameController *	SDL_gamecontrollers = NULL
static SDL_JoystickGUID	s_zeroGUID
static ControllerMapping_t *	s_pSupportedControllers = NULL
static ControllerMapping_t *	s_pDefaultMapping = NULL
static ControllerMapping_t *	s_pXInputMapping = NULL
static SDL_vidpid_list	SDL_allowed_controllers
static SDL_vidpid_list	SDL_ignored_controllers
static const char *	map_StringForControllerAxis []
static const char *	map_StringForControllerButton []

Macro Definition Documentation

SDL_CONTROLLER_HINT_FIELD

#define SDL_CONTROLLER_HINT_FIELD   "hint:"

Definition at line 46 of file SDL_gamecontroller.c.

SDL_CONTROLLER_PLATFORM_FIELD

#define SDL_CONTROLLER_PLATFORM_FIELD   "platform:"

Definition at line 45 of file SDL_gamecontroller.c.

SDL_CONTROLLER_SDKGE_FIELD

#define SDL_CONTROLLER_SDKGE_FIELD   "sdk>=:"

Definition at line 47 of file SDL_gamecontroller.c.

SDL_CONTROLLER_SDKLE_FIELD

#define SDL_CONTROLLER_SDKLE_FIELD   "sdk<=:"

Definition at line 48 of file SDL_gamecontroller.c.

SDL_MINIMUM_GUIDE_BUTTON_DELAY_MS

#define SDL_MINIMUM_GUIDE_BUTTON_DELAY_MS   250

Definition at line 43 of file SDL_gamecontroller.c.

Enumeration Type Documentation

SDL_ControllerMappingPriority

enum SDL_ControllerMappingPriority

Enumerator
SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT
SDL_CONTROLLER_MAPPING_PRIORITY_API
SDL_CONTROLLER_MAPPING_PRIORITY_USER

Definition at line 89 of file SDL_gamecontroller.c.

{
    SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT,
    SDL_CONTROLLER_MAPPING_PRIORITY_API,
    SDL_CONTROLLER_MAPPING_PRIORITY_USER,
} SDL_ControllerMappingPriority;

Function Documentation

HandleJoystickAxis()

static void HandleJoystickAxis ( SDL_GameController *  gamecontroller, int  axis, int  value  )

static

Definition at line 263 of file SDL_gamecontroller.c.

{
    int i;
    SDL_ExtendedGameControllerBind *last_match = gamecontroller->last_match_axis[axis];
    SDL_ExtendedGameControllerBind *match = NULL;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS &&
            axis == binding->input.axis.axis) {
            if (binding->input.axis.axis_min < binding->input.axis.axis_max) {
                if (value >= binding->input.axis.axis_min &&
                    value <= binding->input.axis.axis_max) {
                    match = binding;
                    break;
                }
            } else {
                if (value >= binding->input.axis.axis_max &&
                    value <= binding->input.axis.axis_min) {
                    match = binding;
                    break;
                }
            }
        }
    }
 
    if (last_match && (!match || !HasSameOutput(last_match, match))) {
        /* Clear the last input that this axis generated */
        ResetOutput(gamecontroller, last_match);
    }
 
    if (match) {
        if (match->outputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
            if (match->input.axis.axis_min != match->output.axis.axis_min || match->input.axis.axis_max != match->output.axis.axis_max) {
                float normalized_value = (float)(value - match->input.axis.axis_min) / (match->input.axis.axis_max - match->input.axis.axis_min);
                value = match->output.axis.axis_min + (int)(normalized_value * (match->output.axis.axis_max - match->output.axis.axis_min));
            }
            SDL_PrivateGameControllerAxis(gamecontroller, match->output.axis.axis, (Sint16)value);
        } else {
            Uint8 state;
            int threshold = match->input.axis.axis_min + (match->input.axis.axis_max - match->input.axis.axis_min) / 2;
            if (match->input.axis.axis_max < match->input.axis.axis_min) {
                state = (value <= threshold) ? SDL_PRESSED : SDL_RELEASED;
            } else {
                state = (value >= threshold) ? SDL_PRESSED : SDL_RELEASED;
            }
            SDL_PrivateGameControllerButton(gamecontroller, match->output.button, state);
        }
    }
    gamecontroller->last_match_axis[axis] = match;
}

References SDL_ExtendedGameControllerBind::axis, axis, SDL_ExtendedGameControllerBind::button, gamecontroller, HasSameOutput(), i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, int(), NULL, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, ResetOutput(), SDL_CONTROLLER_BINDTYPE_AXIS, SDL_PRESSED, SDL_PrivateGameControllerAxis(), SDL_PrivateGameControllerButton(), SDL_RELEASED, and state.

Referenced by SDL_GameControllerEventWatcher().

HandleJoystickButton()

static void HandleJoystickButton ( SDL_GameController *  gamecontroller, int  button, Uint8  state  )

static

Definition at line 315 of file SDL_gamecontroller.c.

{
    int i;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON &&
            button == binding->input.button) {
            if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                int value = state ? binding->output.axis.axis_max : binding->output.axis.axis_min;
                SDL_PrivateGameControllerAxis(gamecontroller, binding->output.axis.axis, (Sint16)value);
            } else {
                SDL_PrivateGameControllerButton(gamecontroller, binding->output.button, state);
            }
            break;
        }
    }
}

References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, button, gamecontroller, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_PrivateGameControllerAxis(), SDL_PrivateGameControllerButton(), and state.

Referenced by SDL_GameControllerEventWatcher().

HandleJoystickHat()

static void HandleJoystickHat ( SDL_GameController *  gamecontroller, int  hat, Uint8  value  )

static

Definition at line 334 of file SDL_gamecontroller.c.

{
    int i;
    Uint8 last_mask = gamecontroller->last_hat_mask[hat];
    Uint8 changed_mask = (last_mask ^ value);
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT && hat == binding->input.hat.hat) {
            if ((changed_mask & binding->input.hat.hat_mask) != 0) {
                if (value & binding->input.hat.hat_mask) {
                    if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                        SDL_PrivateGameControllerAxis(gamecontroller, binding->output.axis.axis, (Sint16)binding->output.axis.axis_max);
                    } else {
                        SDL_PrivateGameControllerButton(gamecontroller, binding->output.button, SDL_PRESSED);
                    }
                } else {
                    ResetOutput(gamecontroller, binding);
                }
            }
        }
    }
    gamecontroller->last_hat_mask[hat] = value;
}

References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, ResetOutput(), SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_HAT, SDL_PRESSED, SDL_PrivateGameControllerAxis(), and SDL_PrivateGameControllerButton().

Referenced by SDL_GameControllerEventWatcher().

HasSameOutput()

static SDL_bool HasSameOutput ( SDL_ExtendedGameControllerBind *  a, SDL_ExtendedGameControllerBind *  b  )

static

Definition at line 241 of file SDL_gamecontroller.c.

{
    if (a->outputType != b->outputType) {
        return SDL_FALSE;
    }
 
    if (a->outputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
        return (a->output.axis.axis == b->output.axis.axis);
    } else {
        return (a->output.button == b->output.button);
    }
}

References SDL_CONTROLLER_BINDTYPE_AXIS, and SDL_FALSE.

Referenced by HandleJoystickAxis().

RecenterGameController()

static void RecenterGameController ( SDL_GameController *  gamecontroller )

static

Definition at line 366 of file SDL_gamecontroller.c.

{
    SDL_GameControllerButton button;
    SDL_GameControllerAxis axis;
 
    for (button = (SDL_GameControllerButton) 0; button < SDL_CONTROLLER_BUTTON_MAX; button++) {
        if (SDL_GameControllerGetButton(gamecontroller, button)) {
            SDL_PrivateGameControllerButton(gamecontroller, button, SDL_RELEASED);
        }
    }
 
    for (axis = (SDL_GameControllerAxis) 0; axis < SDL_CONTROLLER_AXIS_MAX; axis++) {
        if (SDL_GameControllerGetAxis(gamecontroller, axis) != 0) {
            SDL_PrivateGameControllerAxis(gamecontroller, axis, 0);
        }
    }
}

References axis, button, gamecontroller, SDL_CONTROLLER_AXIS_MAX, SDL_CONTROLLER_BUTTON_MAX, SDL_GameControllerGetAxis(), SDL_GameControllerGetButton(), SDL_PrivateGameControllerAxis(), SDL_PrivateGameControllerButton(), and SDL_RELEASED.

Referenced by SDL_GameControllerEventWatcher().

ResetOutput()

static void ResetOutput ( SDL_GameController *  gamecontroller, SDL_ExtendedGameControllerBind *  bind  )

static

Definition at line 254 of file SDL_gamecontroller.c.

{
    if (bind->outputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
        SDL_PrivateGameControllerAxis(gamecontroller, bind->output.axis.axis, 0);
    } else {
        SDL_PrivateGameControllerButton(gamecontroller, bind->output.button, SDL_RELEASED);
    }
}

References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_PrivateGameControllerAxis(), SDL_PrivateGameControllerButton(), and SDL_RELEASED.

Referenced by HandleJoystickAxis(), and HandleJoystickHat().

SDL_CreateMappingForHIDAPIController()

static ControllerMapping_t* SDL_CreateMappingForHIDAPIController ( SDL_JoystickGUID  guid )

static

Definition at line 566 of file SDL_gamecontroller.c.

{
    SDL_bool existing;
    char mapping_string[1024];
    Uint16 vendor;
    Uint16 product;
 
    SDL_strlcpy(mapping_string, "none,*,", sizeof(mapping_string));
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, &product, NULL);
 
    if (vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_GAMECUBE_ADAPTER) {
        /* GameCube driver has 12 buttons and 6 axes */
        SDL_strlcat(mapping_string, "a:b0,b:b1,dpdown:b6,dpleft:b4,dpright:b5,dpup:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b9,righttrigger:a5,rightx:a2,righty:a3,start:b8,x:b2,y:b3,", sizeof(mapping_string));
    } else {
        /* All other controllers have the standard set of 19 buttons and 6 axes */
        if (!SDL_IsJoystickNintendoSwitchPro(vendor, product) ||
            SDL_GetHintBoolean(SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS, SDL_TRUE)) {
            SDL_strlcat(mapping_string, "a:b0,b:b1,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,", sizeof(mapping_string));
        } else {
            /* Nintendo Switch Pro Controller with swapped face buttons to match Xbox Controller physical layout */
            SDL_strlcat(mapping_string, "a:b1,b:b0,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b3,y:b2,", sizeof(mapping_string));
        }
 
        if (SDL_IsJoystickXboxOneSeriesX(vendor, product)) {
            /* XBox One Series X Controllers have a share button under the guide button */
            SDL_strlcat(mapping_string, "misc1:b15,", sizeof(mapping_string));
        } else if (SDL_IsJoystickXboxOneElite(vendor, product)) {
            /* XBox One Elite Controllers have 4 back paddle buttons */
            SDL_strlcat(mapping_string, "paddle1:b15,paddle2:b17,paddle3:b16,paddle4:b18,", sizeof(mapping_string));
        } else if (SDL_IsJoystickSteamController(vendor, product)) {
            /* Steam controllers have 2 back paddle buttons */
            SDL_strlcat(mapping_string, "paddle1:b16,paddle2:b15,", sizeof(mapping_string));
        } else {
            switch (SDL_GetJoystickGameControllerTypeFromGUID(guid, NULL)) {
            case SDL_CONTROLLER_TYPE_PS4:
                /* PS4 controllers have an additional touchpad button */
                SDL_strlcat(mapping_string, "touchpad:b15,", sizeof(mapping_string));
                break;
            case SDL_CONTROLLER_TYPE_PS5:
                /* PS5 controllers have a microphone button and an additional touchpad button */
                SDL_strlcat(mapping_string, "misc1:b15,touchpad:b16", sizeof(mapping_string));
                break;
            case SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO:
                /* Nintendo Switch Pro controllers have a screenshot button */
                SDL_strlcat(mapping_string, "misc1:b15,", sizeof(mapping_string));
                break;
            default:
                break;
            }
        }
    }
 
    return SDL_PrivateAddMappingForGUID(guid, mapping_string,
                      &existing, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT);
}

References NULL, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT, SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO, SDL_CONTROLLER_TYPE_PS4, SDL_CONTROLLER_TYPE_PS5, SDL_GetHintBoolean, SDL_GetJoystickGameControllerTypeFromGUID(), SDL_GetJoystickGUIDInfo(), SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS, SDL_IsJoystickNintendoSwitchPro(), SDL_IsJoystickSteamController(), SDL_IsJoystickXboxOneElite(), SDL_IsJoystickXboxOneSeriesX(), SDL_PrivateAddMappingForGUID(), SDL_strlcat, SDL_strlcpy, SDL_TRUE, USB_PRODUCT_NINTENDO_GAMECUBE_ADAPTER, and USB_VENDOR_NINTENDO.

Referenced by SDL_PrivateGetControllerMappingForGUID().

SDL_CreateMappingForRAWINPUTController()

static ControllerMapping_t* SDL_CreateMappingForRAWINPUTController ( SDL_JoystickGUID  guid )

static

Definition at line 626 of file SDL_gamecontroller.c.

{
    SDL_bool existing;
    char mapping_string[1024];
 
    SDL_strlcpy(mapping_string, "none,*,", sizeof(mapping_string));
    SDL_strlcat(mapping_string, "a:b0,b:b1,x:b2,y:b3,back:b6,guide:b10,start:b7,leftstick:b8,rightstick:b9,leftshoulder:b4,rightshoulder:b5,dpup:h0.1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:a4,righttrigger:a5,", sizeof(mapping_string));
 
    return SDL_PrivateAddMappingForGUID(guid, mapping_string,
                      &existing, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT);
}

References SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT, SDL_PrivateAddMappingForGUID(), SDL_strlcat, and SDL_strlcpy.

Referenced by SDL_PrivateGetControllerMappingForGUID().

SDL_GameControllerAddMapping()

int SDL_GameControllerAddMapping

(

const char *

mappingString

)

Add or update an existing mapping configuration

Returns

1 if mapping is added, 0 if updated, -1 on error

Definition at line 1455 of file SDL_gamecontroller.c.

{
    return SDL_PrivateGameControllerAddMapping(mappingString, SDL_CONTROLLER_MAPPING_PRIORITY_API);
}

References SDL_CONTROLLER_MAPPING_PRIORITY_API, and SDL_PrivateGameControllerAddMapping().

Referenced by SDL_GameControllerAddMappingsFromRW().

SDL_GameControllerAddMappingsFromRW()

int SDL_GameControllerAddMappingsFromRW	(	SDL_RWops *	rw,
		int	freerw
	)

To count the number of game controllers in the system for the following: int nJoysticks = SDL_NumJoysticks(); int nGameControllers = 0; for (int i = 0; i < nJoysticks; i++) { if (SDL_IsGameController(i)) { nGameControllers++; } }

Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping() you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is: guid,name,mappings

Where GUID is the string value from SDL_JoystickGetGUIDString(), name is the human readable string for the device and mappings are controller mappings to joystick ones. Under Windows there is a reserved GUID of "xinput" that covers any XInput devices. The mapping format for joystick is: bX - a joystick button, index X hX.Y - hat X with value Y aX - axis X of the joystick Buttons can be used as a controller axis and vice versa.

This string shows an example of a valid mapping for a controller "03000000341a00003608000000000000,PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7", Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current SDL_GetPlatform() A community sourced database of controllers is available at https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt

If freerw is non-zero, the stream will be closed after being read.

Returns

number of mappings added, -1 on error

Definition at line 1276 of file SDL_gamecontroller.c.

{
    const char *platform = SDL_GetPlatform();
    int controllers = 0;
    char *buf, *line, *line_end, *tmp, *comma, line_platform[64];
    size_t db_size, platform_len;
    
    if (rw == NULL) {
        return SDL_SetError("Invalid RWops");
    }
    db_size = (size_t)SDL_RWsize(rw);
    
    buf = (char *)SDL_malloc(db_size + 1);
    if (buf == NULL) {
        if (freerw) {
            SDL_RWclose(rw);
        }
        return SDL_SetError("Could not allocate space to read DB into memory");
    }
    
    if (SDL_RWread(rw, buf, db_size, 1) != 1) {
        if (freerw) {
            SDL_RWclose(rw);
        }
        SDL_free(buf);
        return SDL_SetError("Could not read DB");
    }
    
    if (freerw) {
        SDL_RWclose(rw);
    }
    
    buf[db_size] = '\0';
    line = buf;
    
    while (line < buf + db_size) {
        line_end = SDL_strchr(line, '\n');
        if (line_end != NULL) {
            *line_end = '\0';
        } else {
            line_end = buf + db_size;
        }
        
        /* Extract and verify the platform */
        tmp = SDL_strstr(line, SDL_CONTROLLER_PLATFORM_FIELD);
        if (tmp != NULL) {
            tmp += SDL_strlen(SDL_CONTROLLER_PLATFORM_FIELD);
            comma = SDL_strchr(tmp, ',');
            if (comma != NULL) {
                platform_len = comma - tmp + 1;
                if (platform_len + 1 < SDL_arraysize(line_platform)) {
                    SDL_strlcpy(line_platform, tmp, platform_len);
                    if (SDL_strncasecmp(line_platform, platform, platform_len) == 0 &&
                        SDL_GameControllerAddMapping(line) > 0) {
                        controllers++;
                    }
                }
            }
        }
 
        line = line_end + 1;
    }
 
    SDL_free(buf);
    return controllers;
}

References sort_controllers::controllers, NULL, SDL_arraysize, SDL_CONTROLLER_PLATFORM_FIELD, SDL_free, SDL_GameControllerAddMapping(), SDL_GetPlatform, SDL_malloc, SDL_RWclose, SDL_RWread, SDL_RWsize, SDL_SetError, SDL_strchr, SDL_strlcpy, SDL_strlen, SDL_strncasecmp, and SDL_strstr.

SDL_GameControllerClose()

void SDL_GameControllerClose

(

SDL_GameController *

gamecontroller

)

Close a controller previously opened with SDL_GameControllerOpen().

Definition at line 2393 of file SDL_gamecontroller.c.

{
    SDL_GameController *gamecontrollerlist, *gamecontrollerlistprev;
 
    if (!gamecontroller)
        return;
 
    SDL_LockJoysticks();
 
    /* First decrement ref count */
    if (--gamecontroller->ref_count > 0) {
        SDL_UnlockJoysticks();
        return;
    }
 
    SDL_JoystickClose(gamecontroller->joystick);
 
    gamecontrollerlist = SDL_gamecontrollers;
    gamecontrollerlistprev = NULL;
    while (gamecontrollerlist) {
        if (gamecontroller == gamecontrollerlist) {
            if (gamecontrollerlistprev) {
                /* unlink this entry */
                gamecontrollerlistprev->next = gamecontrollerlist->next;
            } else {
                SDL_gamecontrollers = gamecontroller->next;
            }
            break;
        }
        gamecontrollerlistprev = gamecontrollerlist;
        gamecontrollerlist = gamecontrollerlist->next;
    }
 
    SDL_free(gamecontroller->bindings);
    SDL_free(gamecontroller->last_match_axis);
    SDL_free(gamecontroller->last_hat_mask);
    SDL_free(gamecontroller);
 
    SDL_UnlockJoysticks();
}

References gamecontroller, NULL, SDL_free, SDL_gamecontrollers, SDL_JoystickClose, SDL_LockJoysticks, and SDL_UnlockJoysticks.

Referenced by SDL_GameControllerQuit().

SDL_GameControllerEventState()

int SDL_GameControllerEventState

(

int

state

)

Enable/disable controller event polling.

If controller events are disabled, you must call SDL_GameControllerUpdate() yourself and check the state of the controller when you want controller information.

The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.

Definition at line 2564 of file SDL_gamecontroller.c.

{
#if SDL_EVENTS_DISABLED
    return SDL_IGNORE;
#else
    const Uint32 event_list[] = {
        SDL_CONTROLLERAXISMOTION, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP,
        SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED, SDL_CONTROLLERDEVICEREMAPPED,
    };
    unsigned int i;
 
    switch (state) {
    case SDL_QUERY:
        state = SDL_IGNORE;
        for (i = 0; i < SDL_arraysize(event_list); ++i) {
            state = SDL_EventState(event_list[i], SDL_QUERY);
            if (state == SDL_ENABLE) {
                break;
            }
        }
        break;
    default:
        for (i = 0; i < SDL_arraysize(event_list); ++i) {
            SDL_EventState(event_list[i], state);
        }
        break;
    }
    return (state);
#endif /* SDL_EVENTS_DISABLED */
}

References i, SDL_arraysize, SDL_CONTROLLERAXISMOTION, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMAPPED, SDL_CONTROLLERDEVICEREMOVED, SDL_ENABLE, SDL_EventState, SDL_IGNORE, SDL_QUERY, and state.

SDL_GameControllerEventWatcher()

static int SDL_GameControllerEventWatcher ( void *  userdata, SDL_Event *  event  )

static

Definition at line 388 of file SDL_gamecontroller.c.

{
    switch(event->type) {
    case SDL_JOYAXISMOTION:
        {
            SDL_GameController *controllerlist = SDL_gamecontrollers;
            while (controllerlist) {
                if (controllerlist->joystick->instance_id == event->jaxis.which) {
                    HandleJoystickAxis(controllerlist, event->jaxis.axis, event->jaxis.value);
                    break;
                }
                controllerlist = controllerlist->next;
            }
        }
        break;
    case SDL_JOYBUTTONDOWN:
    case SDL_JOYBUTTONUP:
        {
            SDL_GameController *controllerlist = SDL_gamecontrollers;
            while (controllerlist) {
                if (controllerlist->joystick->instance_id == event->jbutton.which) {
                    HandleJoystickButton(controllerlist, event->jbutton.button, event->jbutton.state);
                    break;
                }
                controllerlist = controllerlist->next;
            }
        }
        break;
    case SDL_JOYHATMOTION:
        {
            SDL_GameController *controllerlist = SDL_gamecontrollers;
            while (controllerlist) {
                if (controllerlist->joystick->instance_id == event->jhat.which) {
                    HandleJoystickHat(controllerlist, event->jhat.hat, event->jhat.value);
                    break;
                }
                controllerlist = controllerlist->next;
            }
        }
        break;
    case SDL_JOYDEVICEADDED:
        {
            if (SDL_IsGameController(event->jdevice.which)) {
                SDL_Event deviceevent;
                deviceevent.type = SDL_CONTROLLERDEVICEADDED;
                deviceevent.cdevice.which = event->jdevice.which;
                SDL_PushEvent(&deviceevent);
            }
        }
        break;
    case SDL_JOYDEVICEREMOVED:
        {
            SDL_GameController *controllerlist = SDL_gamecontrollers;
            int device_index = 0;
            while (controllerlist) {
                if (controllerlist->joystick->instance_id == event->jdevice.which) {
                    SDL_Event deviceevent;
 
                    RecenterGameController(controllerlist);
 
                    deviceevent.type = SDL_CONTROLLERDEVICEREMOVED;
                    deviceevent.cdevice.which = event->jdevice.which;
                    SDL_PushEvent(&deviceevent);
 
                    UpdateEventsForDeviceRemoval(device_index);
                    break;
                }
                controllerlist = controllerlist->next;
                ++device_index;
            }
        }
        break;
    default:
        break;
    }
 
    return 1;
}

References SDL_Event::cdevice, HandleJoystickAxis(), HandleJoystickButton(), HandleJoystickHat(), RecenterGameController(), SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED, SDL_gamecontrollers, SDL_IsGameController(), SDL_JOYAXISMOTION, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED, SDL_JOYHATMOTION, SDL_PushEvent, SDL_Event::type, UpdateEventsForDeviceRemoval(), and SDL_ControllerDeviceEvent::which.

Referenced by SDL_GameControllerInit(), and SDL_GameControllerQuitMappings().

SDL_GameControllerFromInstanceID()

SDL_GameController* SDL_GameControllerFromInstanceID

(

SDL_JoystickID

joyid

)

Return the SDL_GameController associated with an instance id.

Definition at line 2274 of file SDL_gamecontroller.c.

{
    SDL_GameController *gamecontroller;
 
    SDL_LockJoysticks();
    gamecontroller = SDL_gamecontrollers;
    while (gamecontroller) {
        if (gamecontroller->joystick->instance_id == joyid) {
            SDL_UnlockJoysticks();
            return gamecontroller;
        }
        gamecontroller = gamecontroller->next;
    }
    SDL_UnlockJoysticks();
    return NULL;
}

References gamecontroller, NULL, SDL_gamecontrollers, SDL_LockJoysticks, and SDL_UnlockJoysticks.

Referenced by SDL_GameControllerFromPlayerIndex().

SDL_GameControllerFromPlayerIndex()

SDL_GameController* SDL_GameControllerFromPlayerIndex

(

int

player_index

)

Return the SDL_GameController associated with a player index.

Definition at line 2295 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_JoystickFromPlayerIndex(player_index);
    if (joystick) {
        return SDL_GameControllerFromInstanceID(joystick->instance_id);
    }
    return NULL;
}

References joystick, NULL, SDL_GameControllerFromInstanceID(), and SDL_JoystickFromPlayerIndex.

SDL_GameControllerGetAttached()

SDL_bool SDL_GameControllerGetAttached

(

SDL_GameController *

gamecontroller

)

Returns SDL_TRUE if the controller has been opened and currently connected, or SDL_FALSE if it has not.

Definition at line 2249 of file SDL_gamecontroller.c.

{
    if (!gamecontroller)
        return SDL_FALSE;
 
    return SDL_JoystickGetAttached(gamecontroller->joystick);
}

References gamecontroller, SDL_FALSE, and SDL_JoystickGetAttached.

SDL_GameControllerGetAxis()

Sint16 SDL_GameControllerGetAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Get the current state of an axis control on a game controller.

The state is a value ranging from -32768 to 32767 (except for the triggers, which range from 0 to 32767).

The axis indices start at index 0.

Definition at line 1910 of file SDL_gamecontroller.c.

{
    int i;
 
    if (!gamecontroller)
        return 0;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS && binding->output.axis.axis == axis) {
            int value = 0;
            SDL_bool valid_input_range;
            SDL_bool valid_output_range;
 
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                value = SDL_JoystickGetAxis(gamecontroller->joystick, binding->input.axis.axis);
                if (binding->input.axis.axis_min < binding->input.axis.axis_max) {
                    valid_input_range = (value >= binding->input.axis.axis_min && value <= binding->input.axis.axis_max);
                } else {
                    valid_input_range = (value >= binding->input.axis.axis_max && value <= binding->input.axis.axis_min);
                }
                if (valid_input_range) {
                    if (binding->input.axis.axis_min != binding->output.axis.axis_min || binding->input.axis.axis_max != binding->output.axis.axis_max) {
                        float normalized_value = (float)(value - binding->input.axis.axis_min) / (binding->input.axis.axis_max - binding->input.axis.axis_min);
                        value = binding->output.axis.axis_min + (int)(normalized_value * (binding->output.axis.axis_max - binding->output.axis.axis_min));
                    }
                } else {
                    value = 0;
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                value = SDL_JoystickGetButton(gamecontroller->joystick, binding->input.button);
                if (value == SDL_PRESSED) {
                    value = binding->output.axis.axis_max;
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                int hat_mask = SDL_JoystickGetHat(gamecontroller->joystick, binding->input.hat.hat);
                if (hat_mask & binding->input.hat.hat_mask) {
                    value = binding->output.axis.axis_max;
                }
            }
 
            if (binding->output.axis.axis_min < binding->output.axis.axis_max) {
                valid_output_range = (value >= binding->output.axis.axis_min && value <= binding->output.axis.axis_max);
            } else {
                valid_output_range = (value >= binding->output.axis.axis_max && value <= binding->output.axis.axis_min);
            }
            /* If the value is zero, there might be another binding that makes it non-zero */
            if (value != 0 && valid_output_range) {
                return (Sint16)value;
            }
        }
    }
    return 0;
}

References SDL_ExtendedGameControllerBind::axis, axis, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, int(), SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_JoystickGetAxis, SDL_JoystickGetButton, SDL_JoystickGetHat, and SDL_PRESSED.

Referenced by RecenterGameController().

SDL_GameControllerGetAxisFromString()

SDL_GameControllerAxis SDL_GameControllerGetAxisFromString

(

const char *

pchString

)

turn this string into a axis mapping

Definition at line 687 of file SDL_gamecontroller.c.

{
    int entry;
 
    if (pchString && (*pchString == '+' || *pchString == '-')) {
        ++pchString;
    }
 
    if (!pchString || !pchString[0]) {
        return SDL_CONTROLLER_AXIS_INVALID;
    }
 
    for (entry = 0; map_StringForControllerAxis[entry]; ++entry) {
        if (!SDL_strcasecmp(pchString, map_StringForControllerAxis[entry]))
            return (SDL_GameControllerAxis) entry;
    }
    return SDL_CONTROLLER_AXIS_INVALID;
}

References map_StringForControllerAxis, SDL_CONTROLLER_AXIS_INVALID, and SDL_strcasecmp.

Referenced by SDL_PrivateGameControllerParseElement().

SDL_GameControllerGetBindForAxis()

SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Get the SDL joystick layer binding for this controller button mapping

Definition at line 2308 of file SDL_gamecontroller.c.

{
    int i;
    SDL_GameControllerButtonBind bind;
    SDL_zero(bind);
 
    if (!gamecontroller || axis == SDL_CONTROLLER_AXIS_INVALID)
        return bind;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS && binding->output.axis.axis == axis) {
            bind.bindType = binding->inputType;
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                /* FIXME: There might be multiple axes bound now that we have axis ranges... */
                bind.value.axis = binding->input.axis.axis;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                bind.value.button = binding->input.button;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                bind.value.hat.hat = binding->input.hat.hat;
                bind.value.hat.hat_mask = binding->input.hat.hat_mask;
            }
            break;
        }
    }
    return bind;
}

References SDL_GameControllerButtonBind::axis, SDL_ExtendedGameControllerBind::axis, axis, SDL_GameControllerButtonBind::bindType, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_GameControllerButtonBind::hat, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_zero, and SDL_GameControllerButtonBind::value.

Referenced by SDL_GameControllerHasAxis().

SDL_GameControllerGetBindForButton()

SDL_GameControllerButtonBind SDL_GameControllerGetBindForButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Get the SDL joystick layer binding for this controller button mapping

Definition at line 2340 of file SDL_gamecontroller.c.

{
    int i;
    SDL_GameControllerButtonBind bind;
    SDL_zero(bind);
 
    if (!gamecontroller || button == SDL_CONTROLLER_BUTTON_INVALID)
        return bind;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_BUTTON && binding->output.button == button) {
            bind.bindType = binding->inputType;
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                bind.value.axis = binding->input.axis.axis;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                bind.value.button = binding->input.button;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                bind.value.hat.hat = binding->input.hat.hat;
                bind.value.hat.hat_mask = binding->input.hat.hat_mask;
            }
            break;
        }
    }
    return bind;
}

References SDL_GameControllerButtonBind::axis, SDL_ExtendedGameControllerBind::axis, SDL_GameControllerButtonBind::bindType, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::button, button, gamecontroller, SDL_GameControllerButtonBind::hat, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_CONTROLLER_BUTTON_INVALID, SDL_zero, and SDL_GameControllerButtonBind::value.

Referenced by SDL_GameControllerHasButton().

SDL_GameControllerGetButton()

Uint8 SDL_GameControllerGetButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Get the current state of a button on a game controller.

The button indices start at index 0.

Definition at line 1979 of file SDL_gamecontroller.c.

{
    int i;
 
    if (!gamecontroller)
        return 0;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_BUTTON && binding->output.button == button) {
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                SDL_bool valid_input_range;
 
                int value = SDL_JoystickGetAxis(gamecontroller->joystick, binding->input.axis.axis);
                int threshold = binding->input.axis.axis_min + (binding->input.axis.axis_max - binding->input.axis.axis_min) / 2;
                if (binding->input.axis.axis_min < binding->input.axis.axis_max) {
                    valid_input_range = (value >= binding->input.axis.axis_min && value <= binding->input.axis.axis_max);
                    if (valid_input_range) {
                        return (value >= threshold) ? SDL_PRESSED : SDL_RELEASED;
                    }
                } else {
                    valid_input_range = (value >= binding->input.axis.axis_max && value <= binding->input.axis.axis_min);
                    if (valid_input_range) {
                        return (value <= threshold) ? SDL_PRESSED : SDL_RELEASED;
                    }
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                return SDL_JoystickGetButton(gamecontroller->joystick, binding->input.button);
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                int hat_mask = SDL_JoystickGetHat(gamecontroller->joystick, binding->input.hat.hat);
                return (hat_mask & binding->input.hat.hat_mask) ? SDL_PRESSED : SDL_RELEASED;
            }
        }
    }
    return SDL_RELEASED;
}

References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, button, gamecontroller, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_JoystickGetAxis, SDL_JoystickGetButton, SDL_JoystickGetHat, SDL_PRESSED, and SDL_RELEASED.

Referenced by RecenterGameController().

SDL_GameControllerGetButtonFromString()

SDL_GameControllerButton SDL_GameControllerGetButtonFromString

(

const char *

pchString

)

turn this string into a button mapping

Definition at line 745 of file SDL_gamecontroller.c.

{
    int entry;
    if (!pchString || !pchString[0])
        return SDL_CONTROLLER_BUTTON_INVALID;
 
    for (entry = 0; map_StringForControllerButton[entry]; ++entry) {
        if (SDL_strcasecmp(pchString, map_StringForControllerButton[entry]) == 0)
            return (SDL_GameControllerButton) entry;
    }
    return SDL_CONTROLLER_BUTTON_INVALID;
}

References map_StringForControllerButton, SDL_CONTROLLER_BUTTON_INVALID, and SDL_strcasecmp.

Referenced by SDL_PrivateGameControllerParseElement().

SDL_GameControllerGetJoystick()

SDL_Joystick* SDL_GameControllerGetJoystick

(

SDL_GameController *

gamecontroller

)

Get the underlying joystick object used by a controller

Definition at line 2261 of file SDL_gamecontroller.c.

{
    if (!gamecontroller)
        return NULL;
 
    return gamecontroller->joystick;
}

References gamecontroller, and NULL.

Referenced by SDL_GameControllerGetNumTouchpadFingers(), SDL_GameControllerGetNumTouchpads(), SDL_GameControllerGetPlayerIndex(), SDL_GameControllerGetProduct(), SDL_GameControllerGetProductVersion(), SDL_GameControllerGetSensorData(), SDL_GameControllerGetSerial(), SDL_GameControllerGetTouchpadFinger(), SDL_GameControllerGetType(), SDL_GameControllerGetVendor(), SDL_GameControllerHasLED(), SDL_GameControllerHasSensor(), SDL_GameControllerIsSensorEnabled(), SDL_GameControllerName(), SDL_GameControllerRumble(), SDL_GameControllerRumbleTriggers(), SDL_GameControllerSetLED(), SDL_GameControllerSetPlayerIndex(), and SDL_GameControllerSetSensorEnabled().

SDL_GameControllerGetNumTouchpadFingers()

int SDL_GameControllerGetNumTouchpadFingers	(	SDL_GameController *	gamecontroller,
		int	touchpad
	)

Get the number of supported simultaneous fingers on a touchpad on a game controller.

Definition at line 2033 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick && touchpad >= 0 && touchpad < joystick->ntouchpads) {
        return joystick->touchpads[touchpad].nfingers;
    }
    return 0;
}

References gamecontroller, joystick, and SDL_GameControllerGetJoystick().

SDL_GameControllerGetNumTouchpads()

int SDL_GameControllerGetNumTouchpads

(

SDL_GameController *

gamecontroller

)

Get the number of touchpads on a game controller.

Definition at line 2020 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick) {
        return joystick->ntouchpads;
    }
    return 0;
}

References gamecontroller, joystick, and SDL_GameControllerGetJoystick().

SDL_GameControllerGetPlayerIndex()

int SDL_GameControllerGetPlayerIndex

(

SDL_GameController *

gamecontroller

)

Get the player index of an opened game controller, or -1 if it's not available

For XInput controllers this returns the XInput user index.

Definition at line 2206 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetPlayerIndex(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetPlayerIndex.

SDL_GameControllerGetProduct()

Uint16 SDL_GameControllerGetProduct

(

SDL_GameController *

gamecontroller

)

Get the USB product ID of an opened controller, if available. If the product ID isn't available this function returns 0.

Definition at line 2227 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetProduct(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetProduct.

SDL_GameControllerGetProductVersion()

Uint16 SDL_GameControllerGetProductVersion

(

SDL_GameController *

gamecontroller

)

Get the product version of an opened controller, if available. If the product version isn't available this function returns 0.

Definition at line 2233 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetProductVersion(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetProductVersion.

SDL_GameControllerGetSensorData()

int SDL_GameControllerGetSensorData	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type,
		float *	data,
		int	num_values
	)

Get the current state of a game controller sensor.

The number of values and interpretation of the data is sensor dependent. See SDL_sensor.h for the details for each type of sensor.

Parameters

gamecontroller	The controller to query
type	The type of sensor to query
data	A pointer filled with the current sensor state
num_values	The number of values to write to data

Returns

0 or -1 if an error occurred.

Definition at line 2165 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (!joystick) {
        return SDL_InvalidParamError("gamecontroller");
    }
 
    for (i = 0; i < joystick->nsensors; ++i) {
        SDL_JoystickSensorInfo *sensor = &joystick->sensors[i];
 
        if (sensor->type == type) {
            num_values = SDL_min(num_values, SDL_arraysize(sensor->data));
            SDL_memcpy(data, sensor->data, num_values*sizeof(*data));
            return 0;
        }
    }
    return SDL_Unsupported();
}

References SDL_JoystickSensorInfo::data, gamecontroller, i, joystick, SDL_arraysize, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_memcpy, SDL_min, SDL_Unsupported, and SDL_JoystickSensorInfo::type.

SDL_GameControllerGetSerial()

const char* SDL_GameControllerGetSerial

(

SDL_GameController *

gamecontroller

)

Get the serial number of an opened controller, if available.

Returns the serial number of the controller, or NULL if it is not available.

Definition at line 2239 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetSerial(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetSerial.

SDL_GameControllerGetStringForAxis()

const char* SDL_GameControllerGetStringForAxis

(

SDL_GameControllerAxis

axis

)

turn this axis enum into a string mapping

Definition at line 709 of file SDL_gamecontroller.c.

{
    if (axis > SDL_CONTROLLER_AXIS_INVALID && axis < SDL_CONTROLLER_AXIS_MAX) {
        return map_StringForControllerAxis[axis];
    }
    return NULL;
}

References axis, map_StringForControllerAxis, NULL, SDL_CONTROLLER_AXIS_INVALID, and SDL_CONTROLLER_AXIS_MAX.

SDL_GameControllerGetStringForButton()

const char* SDL_GameControllerGetStringForButton

(

SDL_GameControllerButton

button

)

turn this button enum into a string mapping

Definition at line 761 of file SDL_gamecontroller.c.

{
    if (axis > SDL_CONTROLLER_BUTTON_INVALID && axis < SDL_CONTROLLER_BUTTON_MAX) {
        return map_StringForControllerButton[axis];
    }
    return NULL;
}

References axis, map_StringForControllerButton, NULL, SDL_CONTROLLER_BUTTON_INVALID, and SDL_CONTROLLER_BUTTON_MAX.

SDL_GameControllerGetTouchpadFinger()

int SDL_GameControllerGetTouchpadFinger	(	SDL_GameController *	gamecontroller,
		int	touchpad,
		int	finger,
		Uint8 *	state,
		float *	x,
		float *	y,
		float *	pressure
	)

Get the current state of a finger on a touchpad on a game controller.

Definition at line 2047 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick ) {
        if (touchpad >= 0 && touchpad < joystick->ntouchpads) {
            SDL_JoystickTouchpadInfo *touchpad_info = &joystick->touchpads[touchpad];
            if (finger >= 0 && finger < touchpad_info->nfingers) {
                SDL_JoystickTouchpadFingerInfo *info = &touchpad_info->fingers[finger];
 
                if (state) {
                    *state = info->state;
                }
                if (x) {
                    *x = info->x;
                }
                if (y) {
                    *y = info->y;
                }
                if (pressure) {
                    *pressure = info->pressure;
                }
                return 0;
            } else {
                return SDL_InvalidParamError("finger");
            }
        } else {
            return SDL_InvalidParamError("touchpad");
        }
    } else {
        return SDL_InvalidParamError("gamecontroller");
    }
}

References SDL_JoystickTouchpadInfo::fingers, gamecontroller, joystick, SDL_JoystickTouchpadFingerInfo::pressure, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_JoystickTouchpadFingerInfo::state, state, SDL_JoystickTouchpadFingerInfo::x, and SDL_JoystickTouchpadFingerInfo::y.

SDL_GameControllerGetType()

SDL_GameControllerType SDL_GameControllerGetType

(

SDL_GameController *

gamecontroller

)

Return the type of this currently opened controller

Definition at line 2200 of file SDL_gamecontroller.c.

{
    return SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGetGUID(SDL_GameControllerGetJoystick(gamecontroller)), SDL_JoystickName(SDL_GameControllerGetJoystick(gamecontroller)));
}

References gamecontroller, SDL_GameControllerGetJoystick(), SDL_GetJoystickGameControllerTypeFromGUID(), SDL_JoystickGetGUID, and SDL_JoystickName.

SDL_GameControllerGetVendor()

Uint16 SDL_GameControllerGetVendor

(

SDL_GameController *

gamecontroller

)

Get the USB vendor ID of an opened controller, if available. If the vendor ID isn't available this function returns 0.

Definition at line 2221 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetVendor(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetVendor.

SDL_GameControllerHandleDelayedGuideButton()

void SDL_GameControllerHandleDelayedGuideButton

(

SDL_Joystick *

joystick

)

Definition at line 2596 of file SDL_gamecontroller.c.

{
    SDL_GameController *controllerlist = SDL_gamecontrollers;
    while (controllerlist) {
        if (controllerlist->joystick == joystick) {
            SDL_PrivateGameControllerButton(controllerlist, SDL_CONTROLLER_BUTTON_GUIDE, SDL_RELEASED);
            break;
        }
        controllerlist = controllerlist->next;
    }
}

References joystick, SDL_CONTROLLER_BUTTON_GUIDE, SDL_gamecontrollers, SDL_PrivateGameControllerButton(), and SDL_RELEASED.

Referenced by SDL_JoystickUpdate().

SDL_GameControllerHasAxis()

SDL_bool SDL_GameControllerHasAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Return whether a game controller has a given axis

Definition at line 1900 of file SDL_gamecontroller.c.

{
    SDL_GameControllerButtonBind bind = SDL_GameControllerGetBindForAxis(gamecontroller, axis);
    return (bind.bindType != SDL_CONTROLLER_BINDTYPE_NONE) ? SDL_TRUE : SDL_FALSE;
}

References axis, SDL_GameControllerButtonBind::bindType, gamecontroller, SDL_CONTROLLER_BINDTYPE_NONE, SDL_FALSE, SDL_GameControllerGetBindForAxis(), and SDL_TRUE.

SDL_GameControllerHasButton()

SDL_bool SDL_GameControllerHasButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Return whether a game controller has a given button

Definition at line 1969 of file SDL_gamecontroller.c.

{
    SDL_GameControllerButtonBind bind = SDL_GameControllerGetBindForButton(gamecontroller, button);
    return (bind.bindType != SDL_CONTROLLER_BINDTYPE_NONE) ? SDL_TRUE : SDL_FALSE;
}

References SDL_GameControllerButtonBind::bindType, button, gamecontroller, SDL_CONTROLLER_BINDTYPE_NONE, SDL_FALSE, SDL_GameControllerGetBindForButton(), and SDL_TRUE.

SDL_GameControllerHasLED()

SDL_bool SDL_GameControllerHasLED

(

SDL_GameController *

gamecontroller

)

Return whether a controller has an LED

Parameters

gamecontroller

The controller to query

Returns

SDL_TRUE, or SDL_FALSE if this controller does not have a modifiable LED

Definition at line 2381 of file SDL_gamecontroller.c.

{
    return SDL_JoystickHasLED(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickHasLED.

SDL_GameControllerHasSensor()

SDL_bool SDL_GameControllerHasSensor	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type
	)

Return whether a game controller has a particular sensor.

Definition at line 2085 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (joystick) {
        for (i = 0; i < joystick->nsensors; ++i) {
            if (joystick->sensors[i].type == type) {
                return SDL_TRUE;
            }
        }
    }
    return SDL_FALSE;
}

References gamecontroller, i, joystick, SDL_FALSE, SDL_GameControllerGetJoystick(), and SDL_TRUE.

SDL_GameControllerIgnoreDevicesChanged()

static void SDL_GameControllerIgnoreDevicesChanged ( void *  userdata, const char *  name, const char *  oldValue, const char *  hint  )

static

Definition at line 184 of file SDL_gamecontroller.c.

{
    SDL_LoadVIDPIDListFromHint(hint, &SDL_ignored_controllers);
}

References SDL_ignored_controllers, and SDL_LoadVIDPIDListFromHint().

Referenced by SDL_GameControllerInitMappings(), and SDL_GameControllerQuitMappings().

SDL_GameControllerIgnoreDevicesExceptChanged()

static void SDL_GameControllerIgnoreDevicesExceptChanged ( void *  userdata, const char *  name, const char *  oldValue, const char *  hint  )

static

Definition at line 190 of file SDL_gamecontroller.c.

{
    SDL_LoadVIDPIDListFromHint(hint, &SDL_allowed_controllers);
}

References SDL_allowed_controllers, and SDL_LoadVIDPIDListFromHint().

Referenced by SDL_GameControllerInitMappings(), and SDL_GameControllerQuitMappings().

SDL_GameControllerInit()

int SDL_GameControllerInit

(

void

)

Definition at line 1629 of file SDL_gamecontroller.c.

{
    int i;
 
    /* watch for joy events and fire controller ones if needed */
    SDL_AddEventWatch(SDL_GameControllerEventWatcher, NULL);
 
    /* Send added events for controllers currently attached */
    for (i = 0; i < SDL_NumJoysticks(); ++i) {
        if (SDL_IsGameController(i)) {
            SDL_Event deviceevent;
            deviceevent.type = SDL_CONTROLLERDEVICEADDED;
            deviceevent.cdevice.which = i;
            SDL_PushEvent(&deviceevent);
        }
    }
 
    return (0);
}

References SDL_Event::cdevice, i, NULL, SDL_AddEventWatch, SDL_CONTROLLERDEVICEADDED, SDL_GameControllerEventWatcher(), SDL_IsGameController(), SDL_NumJoysticks, SDL_PushEvent, SDL_Event::type, and SDL_ControllerDeviceEvent::which.

Referenced by SDL_InitSubSystem().

SDL_GameControllerInitMappings()

int SDL_GameControllerInitMappings

(

void

)

Definition at line 1600 of file SDL_gamecontroller.c.

{
    char szControllerMapPath[1024];
    int i = 0;
    const char *pMappingString = NULL;
    pMappingString = s_ControllerMappings[i];
    while (pMappingString) {
        SDL_PrivateGameControllerAddMapping(pMappingString, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT);
 
        i++;
        pMappingString = s_ControllerMappings[i];
    }
 
    if (SDL_GetControllerMappingFilePath(szControllerMapPath, sizeof(szControllerMapPath))) {
        SDL_GameControllerAddMappingsFromFile(szControllerMapPath);        
    }
 
    /* load in any user supplied config */
    SDL_GameControllerLoadHints();
 
    SDL_AddHintCallback(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES,
                        SDL_GameControllerIgnoreDevicesChanged, NULL);
    SDL_AddHintCallback(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT,
                        SDL_GameControllerIgnoreDevicesExceptChanged, NULL);
 
    return (0);
}

References i, NULL, s_ControllerMappings, SDL_AddHintCallback, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT, SDL_GameControllerAddMappingsFromFile, SDL_GameControllerIgnoreDevicesChanged(), SDL_GameControllerIgnoreDevicesExceptChanged(), SDL_GameControllerLoadHints(), SDL_GetControllerMappingFilePath(), SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES, SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT, and SDL_PrivateGameControllerAddMapping().

Referenced by SDL_JoystickInit().

SDL_GameControllerIsSensorEnabled()

SDL_bool SDL_GameControllerIsSensorEnabled	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type
	)

Query whether sensor data reporting is enabled for a game controller

Parameters

gamecontroller	The controller to query
type	The type of sensor to query

Returns

SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise.

Definition at line 2146 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (joystick) {
        for (i = 0; i < joystick->nsensors; ++i) {
            if (joystick->sensors[i].type == type) {
                return joystick->sensors[i].enabled;
            }
        }
    }
    return SDL_FALSE;
}

References gamecontroller, i, joystick, SDL_FALSE, and SDL_GameControllerGetJoystick().

SDL_GameControllerLoadHints()

static void SDL_GameControllerLoadHints ( )

static

Definition at line 1549 of file SDL_gamecontroller.c.

{
    const char *hint = SDL_GetHint(SDL_HINT_GAMECONTROLLERCONFIG);
    if (hint && hint[0]) {
        size_t nchHints = SDL_strlen(hint);
        char *pUserMappings = SDL_malloc(nchHints + 1);
        char *pTempMappings = pUserMappings;
        SDL_memcpy(pUserMappings, hint, nchHints);
        pUserMappings[nchHints] = '\0';
        while (pUserMappings) {
            char *pchNewLine = NULL;
 
            pchNewLine = SDL_strchr(pUserMappings, '\n');
            if (pchNewLine)
                *pchNewLine = '\0';
 
            SDL_PrivateGameControllerAddMapping(pUserMappings, SDL_CONTROLLER_MAPPING_PRIORITY_USER);
 
            if (pchNewLine) {
                pUserMappings = pchNewLine + 1;
            } else {
                pUserMappings = NULL;
            }
        }
        SDL_free(pTempMappings);
    }
}

References NULL, SDL_CONTROLLER_MAPPING_PRIORITY_USER, SDL_free, SDL_GetHint, SDL_HINT_GAMECONTROLLERCONFIG, SDL_malloc, SDL_memcpy, SDL_PrivateGameControllerAddMapping(), SDL_strchr, and SDL_strlen.

Referenced by SDL_GameControllerInitMappings().

SDL_GameControllerMapping()

char* SDL_GameControllerMapping

(

SDL_GameController *

gamecontroller

)

Get a mapping string for an open GameController

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available

Definition at line 1539 of file SDL_gamecontroller.c.

{
    if (!gamecontroller) {
        return NULL;
    }
 
    return SDL_GameControllerMappingForGUID(gamecontroller->joystick->guid);
}

References gamecontroller, NULL, and SDL_GameControllerMappingForGUID().

SDL_GameControllerMappingForDeviceIndex()

char* SDL_GameControllerMappingForDeviceIndex

(

int

joystick_index

)

Get the mapping of a game controller. This can be called before any controllers are opened. If no mapping can be found, this function returns NULL.

Definition at line 1684 of file SDL_gamecontroller.c.

{
    char *pMappingString = NULL;
    ControllerMapping_t *mapping;
 
    SDL_LockJoysticks();
    mapping = SDL_PrivateGetControllerMapping(joystick_index);
    if (mapping) {
        SDL_JoystickGUID guid;
        char pchGUID[33];
        size_t needed;
        guid = SDL_JoystickGetDeviceGUID(joystick_index);
        SDL_JoystickGetGUIDString(guid, pchGUID, sizeof(pchGUID));
        /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
        needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
        pMappingString = SDL_malloc(needed);
        if (!pMappingString) {
            SDL_OutOfMemory();
            SDL_UnlockJoysticks();
            return NULL;
        }
        SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
    }
    SDL_UnlockJoysticks();
    return pMappingString;
}

References NULL, SDL_JoystickGetDeviceGUID, SDL_JoystickGetGUIDString, SDL_LockJoysticks, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_snprintf, SDL_strlen, and SDL_UnlockJoysticks.

SDL_GameControllerMappingForGUID()

char* SDL_GameControllerMappingForGUID

(

SDL_JoystickGUID

guid

)

Get a mapping string for a GUID

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available

Definition at line 1515 of file SDL_gamecontroller.c.

{
    char *pMappingString = NULL;
    ControllerMapping_t *mapping = SDL_PrivateGetControllerMappingForGUID(guid, SDL_FALSE);
    if (mapping) {
        char pchGUID[33];
        size_t needed;
        SDL_JoystickGetGUIDString(guid, pchGUID, sizeof(pchGUID));
        /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
        needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
        pMappingString = SDL_malloc(needed);
        if (!pMappingString) {
            SDL_OutOfMemory();
            return NULL;
        }
        SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
    }
    return pMappingString;
}

References NULL, SDL_FALSE, SDL_JoystickGetGUIDString, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMappingForGUID(), SDL_snprintf, and SDL_strlen.

Referenced by SDL_GameControllerMapping().

SDL_GameControllerMappingForIndex()

char* SDL_GameControllerMappingForIndex

(

int

mapping_index

)

Get the mapping at a particular index.

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if the index is out of range.

Definition at line 1482 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *mapping;
 
    for (mapping = s_pSupportedControllers; mapping; mapping = mapping->next) {
        if (SDL_memcmp(&mapping->guid, &s_zeroGUID, sizeof(mapping->guid)) == 0) {
            continue;
        }
        if (mapping_index == 0) {
            char *pMappingString;
            char pchGUID[33];
            size_t needed;
 
            SDL_JoystickGetGUIDString(mapping->guid, pchGUID, sizeof(pchGUID));
            /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
            needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
            pMappingString = SDL_malloc(needed);
            if (!pMappingString) {
                SDL_OutOfMemory();
                return NULL;
            }
            SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
            return pMappingString;
        }
        --mapping_index;
    }
    return NULL;
}

References NULL, s_pSupportedControllers, s_zeroGUID, SDL_JoystickGetGUIDString, SDL_malloc, SDL_memcmp, SDL_OutOfMemory, SDL_snprintf, and SDL_strlen.

SDL_GameControllerName()

const char* SDL_GameControllerName

(

SDL_GameController *

gamecontroller

)

Return the name for this currently opened controller

Definition at line 2187 of file SDL_gamecontroller.c.

{
    if (!gamecontroller)
        return NULL;
 
    if (SDL_strcmp(gamecontroller->name, "*") == 0) {
        return SDL_JoystickName(SDL_GameControllerGetJoystick(gamecontroller));
    } else {
        return gamecontroller->name;
    }
}

References gamecontroller, NULL, SDL_GameControllerGetJoystick(), SDL_JoystickName, and SDL_strcmp.

SDL_GameControllerNameForIndex()

const char* SDL_GameControllerNameForIndex

(

int

joystick_index

)

Get the implementation dependent name of a game controller. This can be called before any controllers are opened. If no name can be found, this function returns NULL.

Definition at line 1654 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pSupportedController = SDL_PrivateGetControllerMapping(device_index);
    if (pSupportedController) {
        if (SDL_strcmp(pSupportedController->name, "*") == 0) {
            return SDL_JoystickNameForIndex(device_index);
        } else {
            return pSupportedController->name;
        }
    }
    return NULL;
}

References ControllerMapping_t::name, NULL, SDL_JoystickNameForIndex, SDL_PrivateGetControllerMapping(), and SDL_strcmp.

SDL_GameControllerNumMappings()

int SDL_GameControllerNumMappings

(

void

)

Get the number of mappings installed

Returns

the number of mappings

Definition at line 1464 of file SDL_gamecontroller.c.

{
    int num_mappings = 0;
    ControllerMapping_t *mapping;
 
    for (mapping = s_pSupportedControllers; mapping; mapping = mapping->next) {
        if (SDL_memcmp(&mapping->guid, &s_zeroGUID, sizeof(mapping->guid)) == 0) {
            continue;
        }
        ++num_mappings;
    }
    return num_mappings;
}

References s_pSupportedControllers, s_zeroGUID, and SDL_memcmp.

SDL_GameControllerOpen()

SDL_GameController* SDL_GameControllerOpen

(

int

joystick_index

)

Open a game controller for use. The index passed as an argument refers to the N'th game controller on the system. This index is not the value which will identify this controller in future controller events. The joystick's instance id (SDL_JoystickID) will be used there instead.

Returns

A controller identifier, or NULL if an error occurred.

Definition at line 1806 of file SDL_gamecontroller.c.

{
    SDL_JoystickID instance_id;
    SDL_GameController *gamecontroller;
    SDL_GameController *gamecontrollerlist;
    ControllerMapping_t *pSupportedController = NULL;
 
    SDL_LockJoysticks();
 
    gamecontrollerlist = SDL_gamecontrollers;
    /* If the controller is already open, return it */
    instance_id = SDL_JoystickGetDeviceInstanceID(device_index);
    while (gamecontrollerlist) {
        if (instance_id == gamecontrollerlist->joystick->instance_id) {
                gamecontroller = gamecontrollerlist;
                ++gamecontroller->ref_count;
                SDL_UnlockJoysticks();
                return (gamecontroller);
        }
        gamecontrollerlist = gamecontrollerlist->next;
    }
 
    /* Find a controller mapping */
    pSupportedController =  SDL_PrivateGetControllerMapping(device_index);
    if (!pSupportedController) {
        SDL_SetError("Couldn't find mapping for device (%d)", device_index);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    /* Create and initialize the controller */
    gamecontroller = (SDL_GameController *) SDL_calloc(1, sizeof(*gamecontroller));
    if (gamecontroller == NULL) {
        SDL_OutOfMemory();
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    gamecontroller->joystick = SDL_JoystickOpen(device_index);
    if (!gamecontroller->joystick) {
        SDL_free(gamecontroller);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    if (gamecontroller->joystick->naxes) {
        gamecontroller->last_match_axis = (SDL_ExtendedGameControllerBind **)SDL_calloc(gamecontroller->joystick->naxes, sizeof(*gamecontroller->last_match_axis));
        if (!gamecontroller->last_match_axis) {
            SDL_OutOfMemory();
            SDL_JoystickClose(gamecontroller->joystick);
            SDL_free(gamecontroller);
            SDL_UnlockJoysticks();
            return NULL;
        }
    }
    if (gamecontroller->joystick->nhats) {
        gamecontroller->last_hat_mask = (Uint8 *)SDL_calloc(gamecontroller->joystick->nhats, sizeof(*gamecontroller->last_hat_mask));
        if (!gamecontroller->last_hat_mask) {
            SDL_OutOfMemory();
            SDL_JoystickClose(gamecontroller->joystick);
            SDL_free(gamecontroller->last_match_axis);
            SDL_free(gamecontroller);
            SDL_UnlockJoysticks();
            return NULL;
        }
    }
 
    SDL_PrivateLoadButtonMapping(gamecontroller, pSupportedController->name, pSupportedController->mapping);
 
    /* Add the controller to list */
    ++gamecontroller->ref_count;
    /* Link the controller in the list */
    gamecontroller->next = SDL_gamecontrollers;
    SDL_gamecontrollers = gamecontroller;
 
    SDL_UnlockJoysticks();
 
    return (gamecontroller);
}

References gamecontroller, ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_calloc, SDL_free, SDL_gamecontrollers, SDL_JoystickClose, SDL_JoystickGetDeviceInstanceID, SDL_JoystickOpen, SDL_LockJoysticks, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_PrivateLoadButtonMapping(), SDL_SetError, and SDL_UnlockJoysticks.

SDL_GameControllerQuit()

void SDL_GameControllerQuit

(

void

)

Definition at line 2439 of file SDL_gamecontroller.c.

{
    SDL_LockJoysticks();
    while (SDL_gamecontrollers) {
        SDL_gamecontrollers->ref_count = 1;
        SDL_GameControllerClose(SDL_gamecontrollers);
    }
    SDL_UnlockJoysticks();
}

References SDL_GameControllerClose(), SDL_gamecontrollers, SDL_LockJoysticks, and SDL_UnlockJoysticks.

Referenced by SDL_QuitSubSystem().

SDL_GameControllerQuitMappings()

void SDL_GameControllerQuitMappings

(

void

)

Definition at line 2450 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pControllerMap;
 
    while (s_pSupportedControllers) {
        pControllerMap = s_pSupportedControllers;
        s_pSupportedControllers = s_pSupportedControllers->next;
        SDL_free(pControllerMap->name);
        SDL_free(pControllerMap->mapping);
        SDL_free(pControllerMap);
    }
 
    SDL_DelEventWatch(SDL_GameControllerEventWatcher, NULL);
 
    SDL_DelHintCallback(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES,
                        SDL_GameControllerIgnoreDevicesChanged, NULL);
    SDL_DelHintCallback(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT,
                        SDL_GameControllerIgnoreDevicesExceptChanged, NULL);
 
    if (SDL_allowed_controllers.entries) {
        SDL_free(SDL_allowed_controllers.entries);
        SDL_zero(SDL_allowed_controllers);
    }
    if (SDL_ignored_controllers.entries) {
        SDL_free(SDL_ignored_controllers.entries);
        SDL_zero(SDL_ignored_controllers);
    }
}

References SDL_vidpid_list::entries, ControllerMapping_t::mapping, ControllerMapping_t::name, ControllerMapping_t::next, NULL, s_pSupportedControllers, SDL_allowed_controllers, SDL_DelEventWatch, SDL_DelHintCallback, SDL_free, SDL_GameControllerEventWatcher(), SDL_GameControllerIgnoreDevicesChanged(), SDL_GameControllerIgnoreDevicesExceptChanged(), SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES, SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT, SDL_ignored_controllers, and SDL_zero.

Referenced by SDL_JoystickQuit().

SDL_GameControllerRumble()

int SDL_GameControllerRumble	(	SDL_GameController *	gamecontroller,
		Uint16	low_frequency_rumble,
		Uint16	high_frequency_rumble,
		Uint32	duration_ms
	)

Start a rumble effect Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.

Parameters

gamecontroller	The controller to vibrate
low_frequency_rumble	The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
high_frequency_rumble	The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
duration_ms	The duration of the rumble effect, in milliseconds

Returns

0, or -1 if rumble isn't supported on this controller

Definition at line 2369 of file SDL_gamecontroller.c.

{
    return SDL_JoystickRumble(SDL_GameControllerGetJoystick(gamecontroller), low_frequency_rumble, high_frequency_rumble, duration_ms);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickRumble.

SDL_GameControllerRumbleTriggers()

int SDL_GameControllerRumbleTriggers	(	SDL_GameController *	gamecontroller,
		Uint16	left_rumble,
		Uint16	right_rumble,
		Uint32	duration_ms
	)

Start a rumble effect in the game controller's triggers Each call to this function cancels any previous trigger rumble effect, and calling it with 0 intensity stops any rumbling.

Parameters

gamecontroller	The controller to vibrate
left_rumble	The intensity of the left trigger rumble motor, from 0 to 0xFFFF
right_rumble	The intensity of the right trigger rumble motor, from 0 to 0xFFFF
duration_ms	The duration of the rumble effect, in milliseconds

Returns

0, or -1 if rumble isn't supported on this controller

Definition at line 2375 of file SDL_gamecontroller.c.

{
    return SDL_JoystickRumbleTriggers(SDL_GameControllerGetJoystick(gamecontroller), left_rumble, right_rumble, duration_ms);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickRumbleTriggers.

SDL_GameControllerSetLED()

int SDL_GameControllerSetLED	(	SDL_GameController *	gamecontroller,
		Uint8	red,
		Uint8	green,
		Uint8	blue
	)

Update a controller's LED color.

Parameters

gamecontroller	The controller to update
red	The intensity of the red LED
green	The intensity of the green LED
blue	The intensity of the blue LED

Returns

0, or -1 if this controller does not have a modifiable LED

Definition at line 2387 of file SDL_gamecontroller.c.

{
    return SDL_JoystickSetLED(SDL_GameControllerGetJoystick(gamecontroller), red, green, blue);
}

References gamecontroller, red, SDL_GameControllerGetJoystick(), and SDL_JoystickSetLED.

SDL_GameControllerSetPlayerIndex()

void SDL_GameControllerSetPlayerIndex	(	SDL_GameController *	gamecontroller,
		int	player_index
	)

Set the player index of an opened game controller

Definition at line 2215 of file SDL_gamecontroller.c.

{
    SDL_JoystickSetPlayerIndex(SDL_GameControllerGetJoystick(gamecontroller), player_index);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickSetPlayerIndex.

SDL_GameControllerSetSensorEnabled()

int SDL_GameControllerSetSensorEnabled	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type,
		SDL_bool	enabled
	)

Set whether data reporting for a game controller sensor is enabled

Parameters

gamecontroller	The controller to update
type	The type of sensor to enable/disable
enabled	Whether data reporting should be enabled

Returns

0 or -1 if an error occurred.

Definition at line 2103 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (!joystick) {
        return SDL_InvalidParamError("gamecontroller");
    }
 
    for (i = 0; i < joystick->nsensors; ++i) {
        SDL_JoystickSensorInfo *sensor = &joystick->sensors[i];
 
        if (sensor->type == type) {
            if (sensor->enabled == enabled) {
                return 0;
            }
 
            if (enabled) {
                if (joystick->nsensors_enabled == 0) {
                    if (joystick->driver->SetSensorsEnabled(joystick, SDL_TRUE) < 0) {
                        return -1;
                    }
                }
                ++joystick->nsensors_enabled;
            } else {
                if (joystick->nsensors_enabled == 1) {
                    if (joystick->driver->SetSensorsEnabled(joystick, SDL_FALSE) < 0) {
                        return -1;
                    }
                }
                --joystick->nsensors_enabled;
            }
 
            sensor->enabled = enabled;
            return 0;
        }
    }
    return SDL_Unsupported();
}

References SDL_JoystickSensorInfo::enabled, gamecontroller, i, joystick, SDL_FALSE, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_TRUE, SDL_Unsupported, and SDL_JoystickSensorInfo::type.

SDL_GameControllerTypeForIndex()

SDL_GameControllerType SDL_GameControllerTypeForIndex

(

int

joystick_index

)

Get the type of a game controller.

Definition at line 1672 of file SDL_gamecontroller.c.

{
    return SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGetDeviceGUID(joystick_index), SDL_JoystickNameForIndex(joystick_index));
}

References SDL_GetJoystickGameControllerTypeFromGUID(), SDL_JoystickGetDeviceGUID, and SDL_JoystickNameForIndex.

SDL_GameControllerUpdate()

void SDL_GameControllerUpdate

(

void

)

Update the current state of the open game controllers.

This is called automatically by the event loop if any game controller events are enabled.

Definition at line 1890 of file SDL_gamecontroller.c.

{
    /* Just for API completeness; the joystick API does all the work. */
    SDL_JoystickUpdate();
}

References SDL_JoystickUpdate.

SDL_GetControllerMappingFilePath()

static SDL_bool SDL_GetControllerMappingFilePath ( char *  path, size_t  size  )

static

Definition at line 1582 of file SDL_gamecontroller.c.

{
    const char *hint = SDL_GetHint(SDL_HINT_GAMECONTROLLERCONFIG_FILE);
    if (hint && *hint) {
        return SDL_strlcpy(path, hint, size) < size;
    }
 
#if defined(__ANDROID__)
    return SDL_snprintf(path, size, "%s/controller_map.txt", SDL_AndroidGetInternalStoragePath()) < size;
#else
    return SDL_FALSE;
#endif
}

References SDL_AndroidGetInternalStoragePath, SDL_FALSE, SDL_GetHint, SDL_HINT_GAMECONTROLLERCONFIG_FILE, SDL_snprintf, and SDL_strlcpy.

Referenced by SDL_GameControllerInitMappings().

SDL_IsGameController()

SDL_bool SDL_IsGameController

(

int

joystick_index

)

Is the joystick on this index supported by the game controller interface?

Definition at line 1729 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pSupportedController = SDL_PrivateGetControllerMapping(device_index);
    if (pSupportedController) {
        return SDL_TRUE;
    }
    return SDL_FALSE;
}

References SDL_FALSE, SDL_PrivateGetControllerMapping(), and SDL_TRUE.

Referenced by SDL_GameControllerEventWatcher(), and SDL_GameControllerInit().

SDL_IsGameControllerNameAndGUID()

SDL_bool SDL_IsGameControllerNameAndGUID	(	const char *	name,
		SDL_JoystickGUID	guid
	)

Definition at line 1716 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pSupportedController = SDL_PrivateGetControllerMappingForNameAndGUID(name, guid);
    if (pSupportedController) {
        return SDL_TRUE;
    }
    return SDL_FALSE;
}

References SDL_FALSE, SDL_PrivateGetControllerMappingForNameAndGUID(), and SDL_TRUE.

Referenced by SDL_ShouldIgnoreJoystick().

SDL_LoadVIDPIDListFromHint()

static void SDL_LoadVIDPIDListFromHint ( const char *  hint, SDL_vidpid_list *  list  )

static

Definition at line 138 of file SDL_gamecontroller.c.

{
    Uint32 entry;
    char *spot;
    char *file = NULL;
 
    list->num_entries = 0;
 
    if (hint && *hint == '@') {
        spot = file = (char *)SDL_LoadFile(hint+1, NULL);
    } else {
        spot = (char *)hint;
    }
 
    if (!spot) {
        return;
    }
 
    while ((spot = SDL_strstr(spot, "0x")) != NULL) {
        entry = (Uint16)SDL_strtol(spot, &spot, 0);
        entry <<= 16;
        spot = SDL_strstr(spot, "0x");
        if (!spot) {
            break;
        }
        entry |= (Uint16)SDL_strtol(spot, &spot, 0);
 
        if (list->num_entries == list->max_entries) {
            int max_entries = list->max_entries + 16;
            Uint32 *entries = (Uint32 *)SDL_realloc(list->entries, max_entries*sizeof(*list->entries));
            if (entries == NULL) {
                /* Out of memory, go with what we have already */
                break;
            }
            list->entries = entries;
            list->max_entries = max_entries;
        }
        list->entries[list->num_entries++] = entry;
    }
 
    if (file) {
        SDL_free(file);
    }
}

References SDL_vidpid_list::entries, SDL_vidpid_list::max_entries, NULL, SDL_vidpid_list::num_entries, SDL_free, SDL_LoadFile, SDL_realloc, SDL_strstr, and SDL_strtol.

Referenced by SDL_GameControllerIgnoreDevicesChanged(), and SDL_GameControllerIgnoreDevicesExceptChanged().

SDL_PrivateAddMappingForGUID()

static ControllerMapping_t * SDL_PrivateAddMappingForGUID ( SDL_JoystickGUID  jGUID, const char *  mappingString, SDL_bool *  existing, SDL_ControllerMappingPriority  priority  )

static

Definition at line 1058 of file SDL_gamecontroller.c.

{
    char *pchName;
    char *pchMapping;
    ControllerMapping_t *pControllerMapping;
 
    pchName = SDL_PrivateGetControllerNameFromMappingString(mappingString);
    if (!pchName) {
        SDL_SetError("Couldn't parse name from %s", mappingString);
        return NULL;
    }
 
    pchMapping = SDL_PrivateGetControllerMappingFromMappingString(mappingString);
    if (!pchMapping) {
        SDL_free(pchName);
        SDL_SetError("Couldn't parse %s", mappingString);
        return NULL;
    }
 
    pControllerMapping = SDL_PrivateGetControllerMappingForGUID(jGUID, SDL_TRUE);
    if (pControllerMapping) {
        /* Only overwrite the mapping if the priority is the same or higher. */
        if (pControllerMapping->priority <= priority) {
            /* Update existing mapping */
            SDL_free(pControllerMapping->name);
            pControllerMapping->name = pchName;
            SDL_free(pControllerMapping->mapping);
            pControllerMapping->mapping = pchMapping;
            pControllerMapping->priority = priority;
            /* refresh open controllers */
            SDL_PrivateGameControllerRefreshMapping(pControllerMapping);
        } else {
            SDL_free(pchName);
            SDL_free(pchMapping);
        }
        *existing = SDL_TRUE;
    } else {
        pControllerMapping = SDL_malloc(sizeof(*pControllerMapping));
        if (!pControllerMapping) {
            SDL_free(pchName);
            SDL_free(pchMapping);
            SDL_OutOfMemory();
            return NULL;
        }
        pControllerMapping->guid = jGUID;
        pControllerMapping->name = pchName;
        pControllerMapping->mapping = pchMapping;
        pControllerMapping->next = NULL;
        pControllerMapping->priority = priority;
 
        if (s_pSupportedControllers) {
            /* Add the mapping to the end of the list */
            ControllerMapping_t *pCurrMapping, *pPrevMapping;
 
            for ( pPrevMapping = s_pSupportedControllers, pCurrMapping = pPrevMapping->next;
                  pCurrMapping; 
                  pPrevMapping = pCurrMapping, pCurrMapping = pCurrMapping->next ) {
                /* continue; */
            }
            pPrevMapping->next = pControllerMapping;
        } else {
            s_pSupportedControllers = pControllerMapping;
        }
        *existing = SDL_FALSE;
    }
    return pControllerMapping;
}

References ControllerMapping_t::guid, ControllerMapping_t::mapping, ControllerMapping_t::name, ControllerMapping_t::next, NULL, ControllerMapping_t::priority, s_pSupportedControllers, SDL_FALSE, SDL_free, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGameControllerRefreshMapping(), SDL_PrivateGetControllerMappingForGUID(), SDL_PrivateGetControllerMappingFromMappingString(), SDL_PrivateGetControllerNameFromMappingString(), SDL_SetError, and SDL_TRUE.

Referenced by SDL_CreateMappingForHIDAPIController(), SDL_CreateMappingForRAWINPUTController(), SDL_PrivateGameControllerAddMapping(), SDL_PrivateGenerateAutomaticControllerMapping(), and SDL_PrivateGetControllerMappingForNameAndGUID().

SDL_PrivateAppendToMappingString()

static void SDL_PrivateAppendToMappingString ( char *  mapping_string, size_t  mapping_string_len, const char *  input_name, SDL_InputMapping *  mapping  )

static

Definition at line 1157 of file SDL_gamecontroller.c.

{
    char buffer[16];
    if (mapping->kind == EMappingKind_None) {
        return;
    }
 
    SDL_strlcat(mapping_string, input_name, mapping_string_len);
    SDL_strlcat(mapping_string, ":", mapping_string_len);
    switch (mapping->kind) {
        case EMappingKind_Button:
            SDL_snprintf(buffer, sizeof(buffer), "b%i", mapping->target);
            break;
        case EMappingKind_Axis:
            SDL_snprintf(buffer, sizeof(buffer), "a%i", mapping->target);
            break;
        case EMappingKind_Hat:
            SDL_snprintf(buffer, sizeof(buffer), "h%i.%i", mapping->target >> 4, mapping->target & 0x0F);
            break;
        default:
            SDL_assert(SDL_FALSE);
    }
 
    SDL_strlcat(mapping_string, buffer, mapping_string_len);
    SDL_strlcat(mapping_string, ",", mapping_string_len);
}

References EMappingKind_Axis, EMappingKind_Button, EMappingKind_Hat, EMappingKind_None, SDL_assert, SDL_FALSE, SDL_snprintf, and SDL_strlcat.

Referenced by SDL_PrivateGenerateAutomaticControllerMapping().

SDL_PrivateGameControllerAddMapping()

static int SDL_PrivateGameControllerAddMapping ( const char *  mappingString, SDL_ControllerMappingPriority  priority  )

static

Definition at line 1347 of file SDL_gamecontroller.c.

{
    char *pchGUID;
    SDL_JoystickGUID jGUID;
    SDL_bool is_default_mapping = SDL_FALSE;
    SDL_bool is_xinput_mapping = SDL_FALSE;
    SDL_bool existing = SDL_FALSE;
    ControllerMapping_t *pControllerMapping;
 
    if (!mappingString) {
        return SDL_InvalidParamError("mappingString");
    }
 
    { /* Extract and verify the hint field */
        const char *tmp;
 
        tmp = SDL_strstr(mappingString, SDL_CONTROLLER_HINT_FIELD);
        if (tmp != NULL) {
            SDL_bool default_value, value, negate;
            int len;
            char hint[128];
 
            tmp += SDL_strlen(SDL_CONTROLLER_HINT_FIELD);
 
            if (*tmp == '!') {
                negate = SDL_TRUE;
                ++tmp;
            } else {
                negate = SDL_FALSE;
            }
 
            len = 0;
            while (*tmp && *tmp != ',' && *tmp != ':' && len < (sizeof(hint) - 1)) {
                hint[len++] = *tmp++;
            }
            hint[len] = '\0';
 
            if (tmp[0] == ':' && tmp[1] == '=') {
                tmp += 2;
                default_value = SDL_atoi(tmp);
            } else {
                default_value = SDL_FALSE;
            }
 
            value = SDL_GetHintBoolean(hint, default_value);
            if (negate) {
                value = !value;
            }
            if (!value) {
                return 0;
            }
        }
    }
 
#ifdef ANDROID
    { /* Extract and verify the SDK version */
        const char *tmp;
 
        tmp = SDL_strstr(mappingString, SDL_CONTROLLER_SDKGE_FIELD);
        if (tmp != NULL) {
            tmp += SDL_strlen(SDL_CONTROLLER_SDKGE_FIELD);
            if (!(SDL_GetAndroidSDKVersion() >= SDL_atoi(tmp))) {
                return SDL_SetError("SDK version %d < minimum version %d", SDL_GetAndroidSDKVersion(), SDL_atoi(tmp));
            }
        }
        tmp = SDL_strstr(mappingString, SDL_CONTROLLER_SDKLE_FIELD);
        if (tmp != NULL) {
            tmp += SDL_strlen(SDL_CONTROLLER_SDKLE_FIELD);
            if (!(SDL_GetAndroidSDKVersion() <= SDL_atoi(tmp))) {
                return SDL_SetError("SDK version %d > maximum version %d", SDL_GetAndroidSDKVersion(), SDL_atoi(tmp));
            }
        }
    }
#endif
 
    pchGUID = SDL_PrivateGetControllerGUIDFromMappingString(mappingString);
    if (!pchGUID) {
        return SDL_SetError("Couldn't parse GUID from %s", mappingString);
    }
    if (!SDL_strcasecmp(pchGUID, "default")) {
        is_default_mapping = SDL_TRUE;
    } else if (!SDL_strcasecmp(pchGUID, "xinput")) {
        is_xinput_mapping = SDL_TRUE;
    }
    jGUID = SDL_JoystickGetGUIDFromString(pchGUID);
    SDL_free(pchGUID);
 
    pControllerMapping = SDL_PrivateAddMappingForGUID(jGUID, mappingString, &existing, priority);
    if (!pControllerMapping) {
        return -1;
    }
 
    if (existing) {
        return 0;
    } else {
        if (is_default_mapping) {
            s_pDefaultMapping = pControllerMapping;
        } else if (is_xinput_mapping) {
            s_pXInputMapping = pControllerMapping;
        }
        return 1;
    }
}

References NULL, s_pDefaultMapping, s_pXInputMapping, SDL_atoi, SDL_CONTROLLER_HINT_FIELD, SDL_CONTROLLER_SDKGE_FIELD, SDL_CONTROLLER_SDKLE_FIELD, SDL_FALSE, SDL_free, SDL_GetAndroidSDKVersion(), SDL_GetHintBoolean, SDL_InvalidParamError, SDL_JoystickGetGUIDFromString, SDL_PrivateAddMappingForGUID(), SDL_PrivateGetControllerGUIDFromMappingString(), SDL_SetError, SDL_strcasecmp, SDL_strlen, SDL_strstr, and SDL_TRUE.

Referenced by SDL_GameControllerAddMapping(), SDL_GameControllerInitMappings(), and SDL_GameControllerLoadHints().

SDL_PrivateGameControllerAxis()

static int SDL_PrivateGameControllerAxis ( SDL_GameController *  gamecontroller, SDL_GameControllerAxis  axis, Sint16  value  )

static

Definition at line 2483 of file SDL_gamecontroller.c.

{
    int posted;
 
    /* translate the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(SDL_CONTROLLERAXISMOTION) == SDL_ENABLE) {
        SDL_Event event;
        event.type = SDL_CONTROLLERAXISMOTION;
        event.caxis.which = gamecontroller->joystick->instance_id;
        event.caxis.axis = axis;
        event.caxis.value = value;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return (posted);
}

References axis, gamecontroller, SDL_CONTROLLERAXISMOTION, SDL_ENABLE, SDL_GetEventState, and SDL_PushEvent.

Referenced by HandleJoystickAxis(), HandleJoystickButton(), HandleJoystickHat(), RecenterGameController(), and ResetOutput().

SDL_PrivateGameControllerButton()

static int SDL_PrivateGameControllerButton ( SDL_GameController *  gamecontroller, SDL_GameControllerButton  button, Uint8  state  )

static

Definition at line 2507 of file SDL_gamecontroller.c.

{
    int posted;
#if !SDL_EVENTS_DISABLED
    SDL_Event event;
 
    if (button == SDL_CONTROLLER_BUTTON_INVALID)
        return (0);
 
    switch (state) {
    case SDL_PRESSED:
        event.type = SDL_CONTROLLERBUTTONDOWN;
        break;
    case SDL_RELEASED:
        event.type = SDL_CONTROLLERBUTTONUP;
        break;
    default:
        /* Invalid state -- bail */
        return (0);
    }
#endif /* !SDL_EVENTS_DISABLED */
 
    if (button == SDL_CONTROLLER_BUTTON_GUIDE) {
        Uint32 now = SDL_GetTicks();
        if (state == SDL_PRESSED) {
            gamecontroller->guide_button_down = now;
 
            if (gamecontroller->joystick->delayed_guide_button) {
                /* Skip duplicate press */
                return (0);
            }
        } else {
            if (!SDL_TICKS_PASSED(now, gamecontroller->guide_button_down+SDL_MINIMUM_GUIDE_BUTTON_DELAY_MS)) {
                gamecontroller->joystick->delayed_guide_button = SDL_TRUE;
                return (0);
            }
            gamecontroller->joystick->delayed_guide_button = SDL_FALSE;
        }
    }
 
    /* translate the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(event.type) == SDL_ENABLE) {
        event.cbutton.which = gamecontroller->joystick->instance_id;
        event.cbutton.button = button;
        event.cbutton.state = state;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return (posted);
}

References button, gamecontroller, SDL_CONTROLLER_BUTTON_GUIDE, SDL_CONTROLLER_BUTTON_INVALID, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP, SDL_ENABLE, SDL_FALSE, SDL_GetEventState, SDL_GetTicks(), SDL_MINIMUM_GUIDE_BUTTON_DELAY_MS, SDL_PRESSED, SDL_PushEvent, SDL_RELEASED, SDL_TICKS_PASSED, SDL_TRUE, and state.

Referenced by HandleJoystickAxis(), HandleJoystickButton(), HandleJoystickHat(), RecenterGameController(), ResetOutput(), and SDL_GameControllerHandleDelayedGuideButton().

SDL_PrivateGameControllerParseControllerConfigString()

static void SDL_PrivateGameControllerParseControllerConfigString ( SDL_GameController *  gamecontroller, const char *  pchString  )

static

Definition at line 868 of file SDL_gamecontroller.c.

{
    char szGameButton[20];
    char szJoystickButton[20];
    SDL_bool bGameButton = SDL_TRUE;
    int i = 0;
    const char *pchPos = pchString;
 
    SDL_zeroa(szGameButton);
    SDL_zeroa(szJoystickButton);
 
    while (pchPos && *pchPos) {
        if (*pchPos == ':') {
            i = 0;
            bGameButton = SDL_FALSE;
        } else if (*pchPos == ' ') {
 
        } else if (*pchPos == ',') {
            i = 0;
            bGameButton = SDL_TRUE;
            SDL_PrivateGameControllerParseElement(gamecontroller, szGameButton, szJoystickButton);
            SDL_zeroa(szGameButton);
            SDL_zeroa(szJoystickButton);
 
        } else if (bGameButton) {
            if (i >= sizeof(szGameButton)) {
                SDL_SetError("Button name too large: %s", szGameButton);
                return;
            }
            szGameButton[i] = *pchPos;
            i++;
        } else {
            if (i >= sizeof(szJoystickButton)) {
                SDL_SetError("Joystick button name too large: %s", szJoystickButton);
                return;
            }
            szJoystickButton[i] = *pchPos;
            i++;
        }
        pchPos++;
    }
 
    /* No more values if the string was terminated by a comma. Don't report an error. */
    if (szGameButton[0] != '\0' || szJoystickButton[0] != '\0') {
        SDL_PrivateGameControllerParseElement(gamecontroller, szGameButton, szJoystickButton);
    }
}

References gamecontroller, i, SDL_FALSE, SDL_PrivateGameControllerParseElement(), SDL_SetError, SDL_TRUE, and SDL_zeroa.

Referenced by SDL_PrivateLoadButtonMapping().

SDL_PrivateGameControllerParseElement()

static void SDL_PrivateGameControllerParseElement ( SDL_GameController *  gamecontroller, const char *  szGameButton, const char *  szJoystickButton  )

static

Definition at line 772 of file SDL_gamecontroller.c.

{
    SDL_ExtendedGameControllerBind bind;
    SDL_GameControllerButton button;
    SDL_GameControllerAxis axis;
    SDL_bool invert_input = SDL_FALSE;
    char half_axis_input = 0;
    char half_axis_output = 0;
 
    if (*szGameButton == '+' || *szGameButton == '-') {
        half_axis_output = *szGameButton++;
    }
 
    axis = SDL_GameControllerGetAxisFromString(szGameButton);
    button = SDL_GameControllerGetButtonFromString(szGameButton);
    if (axis != SDL_CONTROLLER_AXIS_INVALID) {
        bind.outputType = SDL_CONTROLLER_BINDTYPE_AXIS;
        bind.output.axis.axis = axis;
        if (axis == SDL_CONTROLLER_AXIS_TRIGGERLEFT || axis == SDL_CONTROLLER_AXIS_TRIGGERRIGHT) {
            bind.output.axis.axis_min = 0;
            bind.output.axis.axis_max = SDL_JOYSTICK_AXIS_MAX;
        } else {
            if (half_axis_output == '+') {
                bind.output.axis.axis_min = 0;
                bind.output.axis.axis_max = SDL_JOYSTICK_AXIS_MAX;
            } else if (half_axis_output == '-') {
                bind.output.axis.axis_min = 0;
                bind.output.axis.axis_max = SDL_JOYSTICK_AXIS_MIN;
            } else {
                bind.output.axis.axis_min = SDL_JOYSTICK_AXIS_MIN;
                bind.output.axis.axis_max = SDL_JOYSTICK_AXIS_MAX;
            }
        }
    } else if (button != SDL_CONTROLLER_BUTTON_INVALID) {
        bind.outputType = SDL_CONTROLLER_BINDTYPE_BUTTON;
        bind.output.button = button;
    } else {
        SDL_SetError("Unexpected controller element %s", szGameButton);
        return;
    }
 
    if (*szJoystickButton == '+' || *szJoystickButton == '-') {
        half_axis_input = *szJoystickButton++;
    }
    if (szJoystickButton[SDL_strlen(szJoystickButton) - 1] == '~') {
        invert_input = SDL_TRUE;
    }
 
    if (szJoystickButton[0] == 'a' && SDL_isdigit(szJoystickButton[1])) {
        bind.inputType = SDL_CONTROLLER_BINDTYPE_AXIS;
        bind.input.axis.axis = SDL_atoi(&szJoystickButton[1]);
        if (half_axis_input == '+') {
            bind.input.axis.axis_min = 0;
            bind.input.axis.axis_max = SDL_JOYSTICK_AXIS_MAX;
        } else if (half_axis_input == '-') {
            bind.input.axis.axis_min = 0;
            bind.input.axis.axis_max = SDL_JOYSTICK_AXIS_MIN;
        } else {
            bind.input.axis.axis_min = SDL_JOYSTICK_AXIS_MIN;
            bind.input.axis.axis_max = SDL_JOYSTICK_AXIS_MAX;
        }
        if (invert_input) {
            int tmp = bind.input.axis.axis_min;
            bind.input.axis.axis_min = bind.input.axis.axis_max;
            bind.input.axis.axis_max = tmp;
        }
    } else if (szJoystickButton[0] == 'b' && SDL_isdigit(szJoystickButton[1])) {
        bind.inputType = SDL_CONTROLLER_BINDTYPE_BUTTON;
        bind.input.button = SDL_atoi(&szJoystickButton[1]);
    } else if (szJoystickButton[0] == 'h' && SDL_isdigit(szJoystickButton[1]) &&
               szJoystickButton[2] == '.' && SDL_isdigit(szJoystickButton[3])) {
        int hat = SDL_atoi(&szJoystickButton[1]);
        int mask = SDL_atoi(&szJoystickButton[3]);
        bind.inputType = SDL_CONTROLLER_BINDTYPE_HAT;
        bind.input.hat.hat = hat;
        bind.input.hat.hat_mask = mask;
    } else {
        SDL_SetError("Unexpected joystick element: %s", szJoystickButton);
        return;
    }
 
    ++gamecontroller->num_bindings;
    gamecontroller->bindings = (SDL_ExtendedGameControllerBind *)SDL_realloc(gamecontroller->bindings, gamecontroller->num_bindings * sizeof(*gamecontroller->bindings));
    if (!gamecontroller->bindings) {
        gamecontroller->num_bindings = 0;
        SDL_OutOfMemory();
        return;
    }
    gamecontroller->bindings[gamecontroller->num_bindings - 1] = bind;
}

References SDL_ExtendedGameControllerBind::axis, axis, SDL_ExtendedGameControllerBind::button, button, gamecontroller, SDL_ExtendedGameControllerBind::hat, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_atoi, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_AXIS_TRIGGERLEFT, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_CONTROLLER_BUTTON_INVALID, SDL_FALSE, SDL_GameControllerGetAxisFromString(), SDL_GameControllerGetButtonFromString(), SDL_isdigit, SDL_JOYSTICK_AXIS_MAX, SDL_JOYSTICK_AXIS_MIN, SDL_OutOfMemory, SDL_realloc, SDL_SetError, SDL_strlen, and SDL_TRUE.

Referenced by SDL_PrivateGameControllerParseControllerConfigString().

SDL_PrivateGameControllerRefreshMapping()

static void SDL_PrivateGameControllerRefreshMapping ( ControllerMapping_t *  pControllerMapping )

static

Definition at line 1034 of file SDL_gamecontroller.c.

{
    SDL_GameController *gamecontrollerlist = SDL_gamecontrollers;
    while (gamecontrollerlist) {
        if (!SDL_memcmp(&gamecontrollerlist->joystick->guid, &pControllerMapping->guid, sizeof(pControllerMapping->guid))) {
            /* Not really threadsafe.  Should this lock access within SDL_GameControllerEventWatcher? */
            SDL_PrivateLoadButtonMapping(gamecontrollerlist, pControllerMapping->name, pControllerMapping->mapping);
 
            {
                SDL_Event event;
                event.type = SDL_CONTROLLERDEVICEREMAPPED;
                event.cdevice.which = gamecontrollerlist->joystick->instance_id;
                SDL_PushEvent(&event);
            }
        }
 
        gamecontrollerlist = gamecontrollerlist->next;
    }
}

References ControllerMapping_t::guid, ControllerMapping_t::mapping, ControllerMapping_t::name, SDL_CONTROLLERDEVICEREMAPPED, SDL_gamecontrollers, SDL_memcmp, SDL_PrivateLoadButtonMapping(), and SDL_PushEvent.

Referenced by SDL_PrivateAddMappingForGUID().

SDL_PrivateGenerateAutomaticControllerMapping()

static ControllerMapping_t* SDL_PrivateGenerateAutomaticControllerMapping ( const char *  name, SDL_JoystickGUID  guid, SDL_GamepadMapping *  raw_map  )

static

Definition at line 1187 of file SDL_gamecontroller.c.

{
    SDL_bool existing;
    char name_string[128];
    char mapping[1024];
 
    /* Remove any commas in the name */
    SDL_strlcpy(name_string, name, sizeof(name_string));
    {
        char *spot;
        for (spot = name_string; *spot; ++spot) {
            if (*spot == ',') {
                *spot = ' ';
            }
        }
    }
    SDL_snprintf(mapping, sizeof(mapping), "none,%s,", name_string);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "a", &raw_map->a);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "b", &raw_map->b);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "x", &raw_map->x);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "y", &raw_map->y);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "back", &raw_map->back);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "guide", &raw_map->guide);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "start", &raw_map->start);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "leftstick", &raw_map->leftstick);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "rightstick", &raw_map->rightstick);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "leftshoulder", &raw_map->leftshoulder);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "rightshoulder", &raw_map->rightshoulder);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "dpup", &raw_map->dpup);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "dpdown", &raw_map->dpdown);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "dpleft", &raw_map->dpleft);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "dpright", &raw_map->dpright);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "leftx", &raw_map->leftx);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "lefty", &raw_map->lefty);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "rightx", &raw_map->rightx);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "righty", &raw_map->righty);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "lefttrigger", &raw_map->lefttrigger);
    SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "righttrigger", &raw_map->righttrigger);
 
    /* Remove trailing comma */
    {
        int pos = (int)SDL_strlen(mapping) - 1;
        if (pos >= 0) {
            if (mapping[pos] == ',') {
                mapping[pos] = '\0';
            }
        }
    }
 
    return SDL_PrivateAddMappingForGUID(guid, mapping,
                      &existing, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT);
}

References SDL_GamepadMapping::a, SDL_GamepadMapping::b, SDL_GamepadMapping::back, SDL_GamepadMapping::dpdown, SDL_GamepadMapping::dpleft, SDL_GamepadMapping::dpright, SDL_GamepadMapping::dpup, SDL_GamepadMapping::guide, int(), SDL_GamepadMapping::leftshoulder, SDL_GamepadMapping::leftstick, SDL_GamepadMapping::lefttrigger, SDL_GamepadMapping::leftx, SDL_GamepadMapping::lefty, SDL_GamepadMapping::rightshoulder, SDL_GamepadMapping::rightstick, SDL_GamepadMapping::righttrigger, SDL_GamepadMapping::rightx, SDL_GamepadMapping::righty, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT, SDL_PrivateAddMappingForGUID(), SDL_PrivateAppendToMappingString(), SDL_snprintf, SDL_strlcpy, SDL_strlen, SDL_GamepadMapping::start, SDL_GamepadMapping::x, and SDL_GamepadMapping::y.

Referenced by SDL_PrivateGetControllerMapping().

SDL_PrivateGetControllerGUIDFromMappingString()

static char* SDL_PrivateGetControllerGUIDFromMappingString ( const char *  pMapping )

static

Definition at line 950 of file SDL_gamecontroller.c.

{
    const char *pFirstComma = SDL_strchr(pMapping, ',');
    if (pFirstComma) {
        char *pchGUID = SDL_malloc(pFirstComma - pMapping + 1);
        if (!pchGUID) {
            SDL_OutOfMemory();
            return NULL;
        }
        SDL_memcpy(pchGUID, pMapping, pFirstComma - pMapping);
        pchGUID[pFirstComma - pMapping] = '\0';
 
        /* Convert old style GUIDs to the new style in 2.0.5 */
#if __WIN32__
        if (SDL_strlen(pchGUID) == 32 &&
            SDL_memcmp(&pchGUID[20], "504944564944", 12) == 0) {
            SDL_memcpy(&pchGUID[20], "000000000000", 12);
            SDL_memcpy(&pchGUID[16], &pchGUID[4], 4);
            SDL_memcpy(&pchGUID[8], &pchGUID[0], 4);
            SDL_memcpy(&pchGUID[0], "03000000", 8);
        }
#elif __MACOSX__
        if (SDL_strlen(pchGUID) == 32 &&
            SDL_memcmp(&pchGUID[4], "000000000000", 12) == 0 &&
            SDL_memcmp(&pchGUID[20], "000000000000", 12) == 0) {
            SDL_memcpy(&pchGUID[20], "000000000000", 12);
            SDL_memcpy(&pchGUID[8], &pchGUID[0], 4);
            SDL_memcpy(&pchGUID[0], "03000000", 8);
        }
#endif
        return pchGUID;
    }
    return NULL;
}

References NULL, SDL_malloc, SDL_memcmp, SDL_memcpy, SDL_OutOfMemory, SDL_strchr, and SDL_strlen.

Referenced by SDL_PrivateGameControllerAddMapping().

SDL_PrivateGetControllerMapping()

static ControllerMapping_t* SDL_PrivateGetControllerMapping ( int  device_index )

static

Definition at line 1242 of file SDL_gamecontroller.c.

{
    const char *name;
    SDL_JoystickGUID guid;
    ControllerMapping_t *mapping;
 
    SDL_LockJoysticks();
 
    if ((device_index < 0) || (device_index >= SDL_NumJoysticks())) {
        SDL_SetError("There are %d joysticks available", SDL_NumJoysticks());
        SDL_UnlockJoysticks();
        return (NULL);
    }
 
    name = SDL_JoystickNameForIndex(device_index);
    guid = SDL_JoystickGetDeviceGUID(device_index);
    mapping = SDL_PrivateGetControllerMappingForNameAndGUID(name, guid);
    if (!mapping) {
        SDL_GamepadMapping raw_map;
 
        SDL_zero(raw_map);
        if (SDL_PrivateJoystickGetAutoGamepadMapping(device_index, &raw_map)) {
            mapping = SDL_PrivateGenerateAutomaticControllerMapping(name, guid, &raw_map);
        }
    }
 
    SDL_UnlockJoysticks();
    return mapping;
}

References NULL, SDL_JoystickGetDeviceGUID, SDL_JoystickNameForIndex, SDL_LockJoysticks, SDL_NumJoysticks, SDL_PrivateGenerateAutomaticControllerMapping(), SDL_PrivateGetControllerMappingForNameAndGUID(), SDL_PrivateJoystickGetAutoGamepadMapping(), SDL_SetError, SDL_UnlockJoysticks, and SDL_zero.

Referenced by SDL_GameControllerMappingForDeviceIndex(), SDL_GameControllerNameForIndex(), SDL_GameControllerOpen(), and SDL_IsGameController().

SDL_PrivateGetControllerMappingForGUID()

static ControllerMapping_t* SDL_PrivateGetControllerMappingForGUID ( SDL_JoystickGUID  guid, SDL_bool  exact_match  )

static

Definition at line 641 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *mapping = s_pSupportedControllers;
 
    while (mapping) {
        if (SDL_memcmp(&guid, &mapping->guid, sizeof(guid)) == 0) {
            return mapping;
        }
        mapping = mapping->next;
    }
 
    if (!exact_match) {
#if SDL_JOYSTICK_XINPUT
        if (SDL_IsJoystickXInput(guid)) {
            /* This is an XInput device */
            return s_pXInputMapping;
        }
#endif
#ifdef __ANDROID__
        if (!mapping && !SDL_IsJoystickHIDAPI(guid)) {
            mapping = SDL_CreateMappingForAndroidController(guid);
        }
#endif
        if (!mapping && SDL_IsJoystickHIDAPI(guid)) {
            mapping = SDL_CreateMappingForHIDAPIController(guid);
        }
        if (!mapping && SDL_IsJoystickRAWINPUT(guid)) {
            mapping = SDL_CreateMappingForRAWINPUTController(guid);
        }
    }
    return mapping;
}

References s_pSupportedControllers, s_pXInputMapping, SDL_CreateMappingForHIDAPIController(), SDL_CreateMappingForRAWINPUTController(), SDL_IsJoystickHIDAPI(), SDL_IsJoystickRAWINPUT(), SDL_IsJoystickXInput(), and SDL_memcmp.

Referenced by SDL_GameControllerMappingForGUID(), SDL_PrivateAddMappingForGUID(), and SDL_PrivateGetControllerMappingForNameAndGUID().

SDL_PrivateGetControllerMappingForNameAndGUID()

static ControllerMapping_t* SDL_PrivateGetControllerMappingForNameAndGUID ( const char *  name, SDL_JoystickGUID  guid  )

static

Definition at line 1129 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *mapping;
 
    mapping = SDL_PrivateGetControllerMappingForGUID(guid, SDL_FALSE);
#ifdef __LINUX__
    if (!mapping && name) {
        if (SDL_strstr(name, "Xbox 360 Wireless Receiver")) {
            /* The Linux driver xpad.c maps the wireless dpad to buttons */
            SDL_bool existing;
            mapping = SDL_PrivateAddMappingForGUID(guid,
"none,X360 Wireless Controller,a:b0,b:b1,back:b6,dpdown:b14,dpleft:b11,dpright:b12,dpup:b13,guide:b8,leftshoulder:b4,leftstick:b9,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b5,rightstick:b10,righttrigger:a5,rightx:a3,righty:a4,start:b7,x:b2,y:b3",
                          &existing, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT);
        }
    }
#endif /* __LINUX__ */
 
    if (!mapping && name && !SDL_IsJoystickWGI(guid)) {
        if (SDL_strstr(name, "Xbox") || SDL_strstr(name, "X-Box") || SDL_strstr(name, "XBOX")) {
            mapping = s_pXInputMapping;
        }
    }
    if (!mapping) {
        mapping = s_pDefaultMapping;
    }
    return mapping;
}

References s_pDefaultMapping, s_pXInputMapping, SDL_CONTROLLER_MAPPING_PRIORITY_DEFAULT, SDL_FALSE, SDL_IsJoystickWGI(), SDL_PrivateAddMappingForGUID(), SDL_PrivateGetControllerMappingForGUID(), and SDL_strstr.

Referenced by SDL_IsGameControllerNameAndGUID(), and SDL_PrivateGetControllerMapping().

SDL_PrivateGetControllerMappingFromMappingString()

static char* SDL_PrivateGetControllerMappingFromMappingString ( const char *  pMapping )

static

Definition at line 1016 of file SDL_gamecontroller.c.

{
    const char *pFirstComma, *pSecondComma;
 
    pFirstComma = SDL_strchr(pMapping, ',');
    if (!pFirstComma)
        return NULL;
 
    pSecondComma = SDL_strchr(pFirstComma + 1, ',');
    if (!pSecondComma)
        return NULL;
 
    return SDL_strdup(pSecondComma + 1); /* mapping is everything after the 3rd comma */
}

References NULL, SDL_strchr, and SDL_strdup.

Referenced by SDL_PrivateAddMappingForGUID().

SDL_PrivateGetControllerNameFromMappingString()

static char* SDL_PrivateGetControllerNameFromMappingString ( const char *  pMapping )

static

Definition at line 989 of file SDL_gamecontroller.c.

{
    const char *pFirstComma, *pSecondComma;
    char *pchName;
 
    pFirstComma = SDL_strchr(pMapping, ',');
    if (!pFirstComma)
        return NULL;
 
    pSecondComma = SDL_strchr(pFirstComma + 1, ',');
    if (!pSecondComma)
        return NULL;
 
    pchName = SDL_malloc(pSecondComma - pFirstComma);
    if (!pchName) {
        SDL_OutOfMemory();
        return NULL;
    }
    SDL_memcpy(pchName, pFirstComma + 1, pSecondComma - pFirstComma);
    pchName[pSecondComma - pFirstComma - 1] = 0;
    return pchName;
}

References NULL, SDL_malloc, SDL_memcpy, SDL_OutOfMemory, and SDL_strchr.

Referenced by SDL_PrivateAddMappingForGUID().

SDL_PrivateLoadButtonMapping()

static void SDL_PrivateLoadButtonMapping ( SDL_GameController *  gamecontroller, const char *  pchName, const char *  pchMapping  )

static

Definition at line 919 of file SDL_gamecontroller.c.

{
    int i;
 
    gamecontroller->name = pchName;
    gamecontroller->num_bindings = 0;
    if (gamecontroller->joystick->naxes) {
        SDL_memset(gamecontroller->last_match_axis, 0, gamecontroller->joystick->naxes * sizeof(*gamecontroller->last_match_axis));
    }
 
    SDL_PrivateGameControllerParseControllerConfigString(gamecontroller, pchMapping);
 
    /* Set the zero point for triggers */
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS &&
            binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS &&
            (binding->output.axis.axis == SDL_CONTROLLER_AXIS_TRIGGERLEFT ||
             binding->output.axis.axis == SDL_CONTROLLER_AXIS_TRIGGERRIGHT)) {
            if (binding->input.axis.axis < gamecontroller->joystick->naxes) {
                gamecontroller->joystick->axes[binding->input.axis.axis].value =
                gamecontroller->joystick->axes[binding->input.axis.axis].zero = (Sint16)binding->input.axis.axis_min;
            }
        }
    }
}

References SDL_ExtendedGameControllerBind::axis, gamecontroller, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_AXIS_TRIGGERLEFT, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_memset, and SDL_PrivateGameControllerParseControllerConfigString().

Referenced by SDL_GameControllerOpen(), and SDL_PrivateGameControllerRefreshMapping().

SDL_ShouldIgnoreGameController()

SDL_bool SDL_ShouldIgnoreGameController	(	const char *	name,
		SDL_JoystickGUID	guid
	)

Definition at line 1741 of file SDL_gamecontroller.c.

{
    int i;
    Uint16 vendor;
    Uint16 product;
    Uint16 version;
    Uint32 vidpid;
 
#if defined(__LINUX__)
    if (name && SDL_strstr(name, "Motion Sensors")) {
        /* Don't treat the PS3 and PS4 motion controls as a separate game controller */
        return SDL_TRUE;
    }
#endif
 
    if (SDL_allowed_controllers.num_entries == 0 &&
        SDL_ignored_controllers.num_entries == 0) {
        return SDL_FALSE;
    }
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, &product, &version);
 
    if (SDL_GetHintBoolean("SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD", SDL_FALSE)) {
        /* We shouldn't ignore Steam's virtual gamepad since it's using the hints to filter out the real controllers so it can remap input for the virtual controller */
        SDL_bool bSteamVirtualGamepad = SDL_FALSE;
#if defined(__LINUX__)
        bSteamVirtualGamepad = (vendor == 0x28DE && product == 0x11FF);
#elif defined(__MACOSX__)
        bSteamVirtualGamepad = (vendor == 0x045E && product == 0x028E && version == 1);
#elif defined(__WIN32__)
        /* We can't tell on Windows, but Steam will block others in input hooks */
        bSteamVirtualGamepad = SDL_TRUE;
#endif
        if (bSteamVirtualGamepad) {
            return SDL_FALSE;
        }
    }
 
    vidpid = MAKE_VIDPID(vendor, product);
 
    if (SDL_allowed_controllers.num_entries > 0) {
        for (i = 0; i < SDL_allowed_controllers.num_entries; ++i) {
            if (vidpid == SDL_allowed_controllers.entries[i]) {
                return SDL_FALSE;
            }
        }
        return SDL_TRUE;
    } else {
        for (i = 0; i < SDL_ignored_controllers.num_entries; ++i) {
            if (vidpid == SDL_ignored_controllers.entries[i]) {
                return SDL_TRUE;
            }
        }
        return SDL_FALSE;
    }
}

References SDL_vidpid_list::entries, i, MAKE_VIDPID, SDL_vidpid_list::num_entries, SDL_allowed_controllers, SDL_FALSE, SDL_GetHintBoolean, SDL_GetJoystickGUIDInfo(), SDL_ignored_controllers, SDL_strstr, and SDL_TRUE.

Referenced by SDL_ShouldIgnoreJoystick().

UpdateEventsForDeviceRemoval()

static void UpdateEventsForDeviceRemoval ( int  device_index )

static

Definition at line 204 of file SDL_gamecontroller.c.

{
    int i, num_events;
    SDL_Event *events;
    SDL_bool isstack;
 
    num_events = SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEADDED);
    if (num_events <= 0) {
        return;
    }
 
    events = SDL_small_alloc(SDL_Event, num_events, &isstack);
    if (!events) {
        return;
    }
 
    num_events = SDL_PeepEvents(events, num_events, SDL_GETEVENT, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEADDED);
    for (i = 0; i < num_events; ++i) {
        if (events[i].cdevice.which < device_index) {
            /* No change for index values lower than the removed device */
        }
        else if (events[i].cdevice.which == device_index) {
            /* Drop this event entirely */
            SDL_memmove(&events[i], &events[i + 1], sizeof(*events) * (num_events - (i + 1)));
            --i;
            --num_events;
        }
        else {
            /* Fix up the device index if greater than the removed device */
            --events[i].cdevice.which;
        }
    }
    SDL_PeepEvents(events, num_events, SDL_ADDEVENT, 0, 0);
 
    SDL_small_free(events, isstack);
}

References SDL_Event::cdevice, events, i, NULL, SDL_ADDEVENT, SDL_CONTROLLERDEVICEADDED, SDL_GETEVENT, SDL_memmove, SDL_PEEKEVENT, SDL_PeepEvents, SDL_small_alloc, SDL_small_free, and SDL_ControllerDeviceEvent::which.

Referenced by SDL_GameControllerEventWatcher().

Variable Documentation

map_StringForControllerAxis

const char* map_StringForControllerAxis[]

static

Initial value:

= {
    "leftx",
    "lefty",
    "rightx",
    "righty",
    "lefttrigger",
    "righttrigger",
    NULL
}

Definition at line 674 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerGetAxisFromString(), and SDL_GameControllerGetStringForAxis().

map_StringForControllerButton

const char* map_StringForControllerButton[]

static

Initial value:

= {
    "a",
    "b",
    "x",
    "y",
    "back",
    "guide",
    "start",
    "leftstick",
    "rightstick",
    "leftshoulder",
    "rightshoulder",
    "dpup",
    "dpdown",
    "dpleft",
    "dpright",
    "misc1",
    "paddle1",
    "paddle2",
    "paddle3",
    "paddle4",
    "touchpad",
    NULL
}

Definition at line 717 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerGetButtonFromString(), and SDL_GameControllerGetStringForButton().

s_pDefaultMapping

ControllerMapping_t* s_pDefaultMapping = NULL

static

Definition at line 107 of file SDL_gamecontroller.c.

Referenced by SDL_PrivateGameControllerAddMapping(), and SDL_PrivateGetControllerMappingForNameAndGUID().

s_pSupportedControllers

ControllerMapping_t* s_pSupportedControllers = NULL

static

Definition at line 106 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerMappingForIndex(), SDL_GameControllerNumMappings(), SDL_GameControllerQuitMappings(), SDL_PrivateAddMappingForGUID(), and SDL_PrivateGetControllerMappingForGUID().

s_pXInputMapping

ControllerMapping_t* s_pXInputMapping = NULL

static

Definition at line 108 of file SDL_gamecontroller.c.

Referenced by SDL_PrivateGameControllerAddMapping(), SDL_PrivateGetControllerMappingForGUID(), and SDL_PrivateGetControllerMappingForNameAndGUID().

s_zeroGUID

SDL_JoystickGUID s_zeroGUID

static

Definition at line 105 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerMappingForIndex(), and SDL_GameControllerNumMappings().

SDL_allowed_controllers

SDL_vidpid_list SDL_allowed_controllers

static

Definition at line 134 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerIgnoreDevicesExceptChanged(), SDL_GameControllerQuitMappings(), and SDL_ShouldIgnoreGameController().

SDL_gamecontrollers

SDL_GameController* SDL_gamecontrollers = NULL

static

Definition at line 51 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerClose(), SDL_GameControllerEventWatcher(), SDL_GameControllerFromInstanceID(), SDL_GameControllerHandleDelayedGuideButton(), SDL_GameControllerOpen(), SDL_GameControllerQuit(), and SDL_PrivateGameControllerRefreshMapping().

SDL_ignored_controllers

SDL_vidpid_list SDL_ignored_controllers

static

Definition at line 135 of file SDL_gamecontroller.c.

Referenced by SDL_GameControllerIgnoreDevicesChanged(), SDL_GameControllerQuitMappings(), and SDL_ShouldIgnoreGameController().