SDL
2.0
|
#include "../SDL_internal.h"
#include "SDL_events.h"
#include "SDL_assert.h"
#include "SDL_sysjoystick.h"
#include "SDL_hints.h"
#include "SDL_gamecontrollerdb.h"
#include "../events/SDL_events_c.h"
Go to the source code of this file.
Data Structures | |
struct | _SDL_HatMapping |
struct | _SDL_ControllerMapping |
struct | ControllerMapping_t |
struct | SDL_GameController |
Macros | |
#define | ABS(_x) ((_x) < 0 ? -(_x) : (_x)) |
#define | SDL_CONTROLLER_PLATFORM_FIELD "platform:" |
#define | k_nMaxReverseEntries 20 |
#define | k_nMaxHatEntries 0x3f + 1 |
Variables | |
static SDL_GameController * | SDL_gamecontrollers = NULL |
static ControllerMapping_t * | s_pSupportedControllers = NULL |
static ControllerMapping_t * | s_pXInputMapping = NULL |
static ControllerMapping_t * | s_pEmscriptenMapping = NULL |
static const char * | map_StringForControllerAxis [] |
static const char * | map_StringForControllerButton [] |
#define ABS | ( | _x | ) | ((_x) < 0 ? -(_x) : (_x)) |
Definition at line 34 of file SDL_gamecontroller.c.
Referenced by SDL_BlendLine_ARGB8888(), SDL_BlendLine_RGB2(), SDL_BlendLine_RGB4(), SDL_BlendLine_RGB555(), SDL_BlendLine_RGB565(), SDL_BlendLine_RGB888(), SDL_BlendLine_RGBA4(), SDL_DrawLine1(), SDL_DrawLine2(), SDL_DrawLine4(), SDL_GameControllerEventWatcher(), and SDL_GameControllerGetButton().
#define k_nMaxHatEntries 0x3f + 1 |
We are encoding the "HAT" as 0xhm. where h == hat ID and m == mask MAX 4 hats supported
Definition at line 54 of file SDL_gamecontroller.c.
Referenced by SDL_PrivateLoadButtonMapping().
#define k_nMaxReverseEntries 20 |
Definition at line 48 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerEventWatcher(), SDL_PrivateGameControllerParseButton(), and SDL_PrivateLoadButtonMapping().
#define SDL_CONTROLLER_PLATFORM_FIELD "platform:" |
Definition at line 36 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerAddMappingsFromRW().
int SDL_GameControllerAddMapping | ( | const char * | mappingString | ) |
Add or update an existing mapping configuration
Definition at line 746 of file SDL_gamecontroller.c.
References SDL_FALSE, SDL_free(), SDL_InvalidParamError, SDL_JoystickGetGUIDFromString, SDL_PrivateAddMappingForGUID(), SDL_PrivateGetControllerGUIDFromMappingString(), SDL_SetError, SDL_strcasecmp, and SDL_TRUE.
Referenced by SDL_GameControllerAddMappingsFromRW(), SDL_GameControllerInit(), and SDL_GameControllerLoadHints().
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 "341a3608000000000000504944564944,Afterglow 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.
Definition at line 675 of file SDL_gamecontroller.c.
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.
void SDL_GameControllerClose | ( | SDL_GameController * | gamecontroller | ) |
Close a controller previously opened with SDL_GameControllerOpen().
Definition at line 1161 of file SDL_gamecontroller.c.
References NULL, SDL_free(), SDL_gamecontrollers, and SDL_JoystickClose.
Referenced by SDL_GameControllerQuit().
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 1287 of file SDL_gamecontroller.c.
References i, SDL_arraysize, SDL_CONTROLLERAXISMOTION, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMAPPED, SDL_CONTROLLERDEVICEREMOVED, SDL_ENABLE, SDL_EventState, SDL_IGNORE, and SDL_QUERY.
Definition at line 111 of file SDL_gamecontroller.c.
References ABS, axis, SDL_JoyAxisEvent::axis, SDL_JoyButtonEvent::button, SDL_Event::cdevice, SDL_JoyHatEvent::hat, SDL_Event::jaxis, SDL_Event::jbutton, SDL_Event::jdevice, SDL_Event::jhat, k_nMaxReverseEntries, SDL_CONTROLLER_AXIS_TRIGGERLEFT, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED, SDL_gamecontrollers, SDL_HAT_DOWN, SDL_HAT_LEFT, SDL_HAT_RIGHT, SDL_HAT_UP, SDL_IsGameController(), SDL_JOYAXISMOTION, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED, SDL_JOYHATMOTION, SDL_PRESSED, SDL_PrivateGameControllerAxis(), SDL_PrivateGameControllerButton(), SDL_PushEvent, SDL_RELEASED, SDL_JoyButtonEvent::state, SDL_Event::type, SDL_JoyAxisEvent::value, SDL_JoyAxisEvent::which, SDL_JoyHatEvent::which, SDL_JoyButtonEvent::which, SDL_JoyDeviceEvent::which, and SDL_ControllerDeviceEvent::which.
Referenced by SDL_GameControllerInit(), and SDL_GameControllerQuit().
SDL_GameController* SDL_GameControllerFromInstanceID | ( | SDL_JoystickID | joyid | ) |
Return the SDL_GameController associated with an instance id.
Definition at line 1096 of file SDL_gamecontroller.c.
References NULL, and SDL_gamecontrollers.
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 1061 of file SDL_gamecontroller.c.
References SDL_FALSE, and SDL_JoystickGetAttached.
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 1000 of file SDL_gamecontroller.c.
References SDL_CONTROLLER_AXIS_TRIGGERLEFT, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, SDL_JoystickGetAxis, and SDL_JoystickGetButton.
SDL_GameControllerAxis SDL_GameControllerGetAxisFromString | ( | const char * | pchString | ) |
turn this string into a axis mapping
Definition at line 270 of file SDL_gamecontroller.c.
References map_StringForControllerAxis, SDL_CONTROLLER_AXIS_INVALID, and SDL_strcasecmp.
Referenced by SDL_PrivateGameControllerParseButton().
SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerAxis | axis | ||
) |
Get the SDL joystick layer binding for this controller axis mapping
Definition at line 1113 of file SDL_gamecontroller.c.
References axis, SDL_GameControllerButtonBind::bindType, SDL_GameControllerButtonBind::button, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_memset, and SDL_GameControllerButtonBind::value.
SDL_GameControllerButtonBind SDL_GameControllerGetBindForButton | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerButton | button | ||
) |
Get the SDL joystick layer binding for this controller button mapping
Definition at line 1136 of file SDL_gamecontroller.c.
References SDL_GameControllerButtonBind::axis, SDL_GameControllerButtonBind::bindType, button, SDL_GameControllerButtonBind::button, SDL_GameControllerButtonBind::hat, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_CONTROLLER_BUTTON_INVALID, SDL_memset, and SDL_GameControllerButtonBind::value.
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 1031 of file SDL_gamecontroller.c.
References ABS, SDL_JoystickGetAxis, SDL_JoystickGetButton, and SDL_JoystickGetHat.
SDL_GameControllerButton SDL_GameControllerGetButtonFromString | ( | const char * | pchString | ) |
turn this string into a button mapping
Definition at line 316 of file SDL_gamecontroller.c.
References map_StringForControllerButton, SDL_CONTROLLER_BUTTON_INVALID, and SDL_strcasecmp.
Referenced by SDL_PrivateGameControllerParseButton().
SDL_Joystick* SDL_GameControllerGetJoystick | ( | SDL_GameController * | gamecontroller | ) |
Get the underlying joystick object used by a controller
Definition at line 1083 of file SDL_gamecontroller.c.
References NULL.
const char* SDL_GameControllerGetStringForAxis | ( | SDL_GameControllerAxis | axis | ) |
turn this axis enum into a string mapping
Definition at line 286 of file SDL_gamecontroller.c.
References axis, map_StringForControllerAxis, NULL, SDL_CONTROLLER_AXIS_INVALID, and SDL_CONTROLLER_AXIS_MAX.
const char* SDL_GameControllerGetStringForButton | ( | SDL_GameControllerButton | button | ) |
turn this button enum into a string mapping
Definition at line 332 of file SDL_gamecontroller.c.
References axis, map_StringForControllerButton, NULL, SDL_CONTROLLER_BUTTON_INVALID, and SDL_CONTROLLER_BUTTON_MAX.
int SDL_GameControllerInit | ( | void | ) |
Definition at line 860 of file SDL_gamecontroller.c.
References SDL_Event::cdevice, i, NULL, s_ControllerMappings, SDL_AddEventWatch, SDL_CONTROLLERDEVICEADDED, SDL_GameControllerAddMapping(), SDL_GameControllerEventWatcher(), SDL_GameControllerLoadHints(), SDL_IsGameController(), SDL_NumJoysticks, SDL_PushEvent, SDL_Event::type, and SDL_ControllerDeviceEvent::which.
Referenced by SDL_InitSubSystem().
|
static |
Definition at line 828 of file SDL_gamecontroller.c.
References NULL, SDL_free(), SDL_GameControllerAddMapping(), SDL_GetHint, SDL_HINT_GAMECONTROLLERCONFIG, SDL_malloc, SDL_memcpy, SDL_strchr, and SDL_strlen.
Referenced by SDL_GameControllerInit().
char* SDL_GameControllerMapping | ( | SDL_GameController * | gamecontroller | ) |
Get a mapping string for an open GameController
Definition at line 818 of file SDL_gamecontroller.c.
References NULL, and SDL_GameControllerMappingForGUID().
char* SDL_GameControllerMappingForGUID | ( | SDL_JoystickGUID | guid | ) |
Get a mapping string for a GUID
Definition at line 794 of file SDL_gamecontroller.c.
References ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_JoystickGetGUIDString, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMappingForGUID(), SDL_snprintf, and SDL_strlen.
Referenced by SDL_GameControllerMapping().
const char* SDL_GameControllerName | ( | SDL_GameController * | gamecontroller | ) |
Return the name for this currently opened controller
Definition at line 1071 of file SDL_gamecontroller.c.
References NULL.
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 897 of file SDL_gamecontroller.c.
References ControllerMapping_t::name, NULL, and SDL_PrivateGetControllerMapping().
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.
Definition at line 929 of file SDL_gamecontroller.c.
References ControllerMapping_t::guid, ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_free(), SDL_gamecontrollers, SDL_JoystickOpen, SDL_malloc, SDL_memset, SDL_NumJoysticks, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_PrivateLoadButtonMapping(), SDL_SetError, SDL_SYS_GetInstanceIdOfDeviceIndex(), and SDL_SYS_JoystickUpdate().
Definition at line 1200 of file SDL_gamecontroller.c.
References ControllerMapping_t::mapping, ControllerMapping_t::name, ControllerMapping_t::next, NULL, s_pSupportedControllers, SDL_DelEventWatch, SDL_free(), SDL_GameControllerClose(), SDL_GameControllerEventWatcher(), and SDL_gamecontrollers.
Referenced by SDL_QuitSubSystem().
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 989 of file SDL_gamecontroller.c.
References SDL_JoystickUpdate.
SDL_bool SDL_IsGameController | ( | int | joystick_index | ) |
Is the joystick on this index supported by the game controller interface?
Definition at line 911 of file SDL_gamecontroller.c.
References SDL_FALSE, SDL_PrivateGetControllerMapping(), and SDL_TRUE.
Referenced by SDL_GameControllerEventWatcher(), and SDL_GameControllerInit().
|
static |
Definition at line 579 of file SDL_gamecontroller.c.
References ControllerMapping_t::guid, ControllerMapping_t::mapping, ControllerMapping_t::name, ControllerMapping_t::next, NULL, 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_GameControllerAddMapping(), and SDL_PrivateGetControllerMapping().
int SDL_PrivateGameControllerAxis | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerAxis | axis, | ||
Sint16 | value | ||
) |
Definition at line 1224 of file SDL_gamecontroller.c.
References axis, SDL_CONTROLLERAXISMOTION, SDL_ENABLE, SDL_GetEventState, and SDL_PushEvent.
Referenced by SDL_GameControllerEventWatcher().
int SDL_PrivateGameControllerButton | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerButton | button, | ||
Uint8 | state | ||
) |
Definition at line 1248 of file SDL_gamecontroller.c.
References button, SDL_CONTROLLER_BUTTON_INVALID, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP, SDL_ENABLE, SDL_GetEventState, SDL_PRESSED, SDL_PushEvent, SDL_RELEASED, state, and SDL_Event::type.
Referenced by SDL_GameControllerEventWatcher().
void SDL_PrivateGameControllerParseButton | ( | const char * | szGameButton, |
const char * | szJoystickButton, | ||
struct _SDL_ControllerMapping * | pMapping | ||
) |
Definition at line 343 of file SDL_gamecontroller.c.
References _SDL_ControllerMapping::axes, _SDL_ControllerMapping::axesasbutton, axis, button, _SDL_ControllerMapping::buttonasaxis, _SDL_ControllerMapping::buttons, _SDL_HatMapping::hat, _SDL_ControllerMapping::hatasbutton, k_nMaxReverseEntries, _SDL_HatMapping::mask, _SDL_ControllerMapping::raxes, _SDL_ControllerMapping::raxesasbutton, _SDL_ControllerMapping::rbuttonasaxis, _SDL_ControllerMapping::rbuttons, _SDL_ControllerMapping::rhatasbutton, SDL_assert, SDL_atoi, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_BUTTON_INVALID, SDL_GameControllerGetAxisFromString(), SDL_GameControllerGetButtonFromString(), and SDL_SetError.
Referenced by SDL_PrivateGameControllerParseControllerConfigString().
|
static |
Definition at line 407 of file SDL_gamecontroller.c.
References i, SDL_FALSE, SDL_memset, SDL_PrivateGameControllerParseButton(), SDL_SetError, and SDL_TRUE.
Referenced by SDL_PrivateLoadButtonMapping().
void SDL_PrivateGameControllerRefreshMapping | ( | ControllerMapping_t * | pControllerMapping | ) |
Definition at line 557 of file SDL_gamecontroller.c.
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().
char* SDL_PrivateGetControllerGUIDFromMappingString | ( | const char * | pMapping | ) |
Definition at line 492 of file SDL_gamecontroller.c.
References NULL, SDL_malloc, SDL_memcpy, SDL_OutOfMemory, and SDL_strchr.
Referenced by SDL_GameControllerAddMapping().
ControllerMapping_t* SDL_PrivateGetControllerMapping | ( | int | device_index | ) |
Definition at line 629 of file SDL_gamecontroller.c.
References s_pEmscriptenMapping, s_pXInputMapping, SDL_JoystickGetDeviceGUID, SDL_JoystickNameForIndex, SDL_PrivateAddMappingForGUID(), SDL_PrivateGetControllerMappingForGUID(), and SDL_strstr.
Referenced by SDL_GameControllerNameForIndex(), SDL_GameControllerOpen(), and SDL_IsGameController().
ControllerMapping_t* SDL_PrivateGetControllerMappingForGUID | ( | SDL_JoystickGUID * | guid | ) |
Definition at line 245 of file SDL_gamecontroller.c.
References ControllerMapping_t::guid, ControllerMapping_t::next, NULL, s_pSupportedControllers, and SDL_memcmp.
Referenced by SDL_GameControllerMappingForGUID(), SDL_PrivateAddMappingForGUID(), and SDL_PrivateGetControllerMapping().
char* SDL_PrivateGetControllerMappingFromMappingString | ( | const char * | pMapping | ) |
Definition at line 539 of file SDL_gamecontroller.c.
References NULL, SDL_strchr, and SDL_strdup.
Referenced by SDL_PrivateAddMappingForGUID().
char* SDL_PrivateGetControllerNameFromMappingString | ( | const char * | pMapping | ) |
Definition at line 512 of file SDL_gamecontroller.c.
References NULL, SDL_malloc, SDL_memcpy, SDL_OutOfMemory, and SDL_strchr.
Referenced by SDL_PrivateAddMappingForGUID().
void SDL_PrivateLoadButtonMapping | ( | struct _SDL_ControllerMapping * | pMapping, |
SDL_JoystickGUID | guid, | ||
const char * | pchName, | ||
const char * | pchMapping | ||
) |
Definition at line 456 of file SDL_gamecontroller.c.
References _SDL_ControllerMapping::axes, _SDL_ControllerMapping::axesasbutton, _SDL_ControllerMapping::buttonasaxis, _SDL_ControllerMapping::buttons, _SDL_ControllerMapping::guid, _SDL_HatMapping::hat, _SDL_ControllerMapping::hatasbutton, j, k_nMaxHatEntries, k_nMaxReverseEntries, _SDL_ControllerMapping::name, _SDL_ControllerMapping::raxes, _SDL_ControllerMapping::raxesasbutton, _SDL_ControllerMapping::rbuttonasaxis, _SDL_ControllerMapping::rbuttons, _SDL_ControllerMapping::rhatasbutton, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_AXIS_MAX, SDL_CONTROLLER_BUTTON_INVALID, SDL_CONTROLLER_BUTTON_MAX, and SDL_PrivateGameControllerParseControllerConfigString().
Referenced by SDL_GameControllerOpen(), and SDL_PrivateGameControllerRefreshMapping().
|
static |
Definition at line 257 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerGetAxisFromString(), and SDL_GameControllerGetStringForAxis().
|
static |
Definition at line 294 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerGetButtonFromString(), and SDL_GameControllerGetStringForButton().
|
static |
Definition at line 92 of file SDL_gamecontroller.c.
Referenced by SDL_PrivateGetControllerMapping().
|
static |
Definition at line 90 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerQuit(), SDL_PrivateAddMappingForGUID(), and SDL_PrivateGetControllerMappingForGUID().
|
static |
Definition at line 91 of file SDL_gamecontroller.c.
Referenced by SDL_PrivateGetControllerMapping().
|
static |
Definition at line 39 of file SDL_gamecontroller.c.
Referenced by SDL_GameControllerClose(), SDL_GameControllerEventWatcher(), SDL_GameControllerFromInstanceID(), SDL_GameControllerOpen(), SDL_GameControllerQuit(), and SDL_PrivateGameControllerRefreshMapping().