SDL
2.0
|
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_rwops.h"
#include "SDL_joystick.h"
#include "begin_code.h"
#include "close_code.h"
Go to the source code of this file.
Data Structures | |
struct | SDL_GameControllerButtonBind |
Macros | |
#define | SDL_GameControllerAddMappingsFromFile(file) SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1) |
Include file for SDL game controller event handling
In order to use these functions, SDL_Init() must have been called with the SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system for game controllers, and load appropriate drivers.
If you would like to receive controller updates while the application is in the background, you should set the following hint before calling SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
Definition in file SDL_gamecontroller.h.
#define SDL_GameControllerAddMappingsFromFile | ( | file | ) | SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1) |
Load a set of mappings from a file, filtered by the current SDL_GetPlatform()
Convenience macro.
Definition at line 129 of file SDL_gamecontroller.h.
Referenced by main(), and SDL_GameControllerInitMappings().
The list of axes available from a controller
Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX, and are centered within ~8000 of zero, though advanced UI will allow users to set or autodetect the dead zone, which varies between controllers.
Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
Definition at line 272 of file SDL_gamecontroller.h.
Enumerator | |
---|---|
SDL_CONTROLLER_BINDTYPE_NONE | |
SDL_CONTROLLER_BINDTYPE_BUTTON | |
SDL_CONTROLLER_BINDTYPE_AXIS | |
SDL_CONTROLLER_BINDTYPE_HAT |
Definition at line 61 of file SDL_gamecontroller.h.
The list of buttons available from a controller
Definition at line 316 of file SDL_gamecontroller.h.
int SDL_GameControllerAddMapping | ( | const char * | mappingString | ) |
Add or update an existing mapping configuration
Definition at line 1200 of file SDL_gamecontroller.c.
References SDL_CONTROLLER_MAPPING_PRIORITY_API, and SDL_PrivateGameControllerAddMapping().
Referenced by 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.
Definition at line 1078 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 1885 of file SDL_gamecontroller.c.
References NULL, SDL_free, SDL_gamecontrollers, SDL_JoystickClose, SDL_LockJoysticks, and SDL_UnlockJoysticks.
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 2056 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.
SDL_GameController* SDL_GameControllerFromInstanceID | ( | SDL_JoystickID | joyid | ) |
Return the SDL_GameController associated with an instance id.
Definition at line 1797 of file SDL_gamecontroller.c.
References NULL, SDL_gamecontrollers, SDL_LockJoysticks, and SDL_UnlockJoysticks.
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 1773 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 1635 of file SDL_gamecontroller.c.
References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, 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, and SDL_PRESSED.
SDL_GameControllerAxis SDL_GameControllerGetAxisFromString | ( | const char * | pchString | ) |
turn this string into a axis mapping
Definition at line 462 of file SDL_gamecontroller.c.
References map_StringForControllerAxis, SDL_CONTROLLER_AXIS_INVALID, and SDL_strcasecmp.
Referenced by SDL_PrivateGameControllerParseElement().
SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerAxis | axis | ||
) |
Get the SDL joystick layer binding for this controller button mapping
Definition at line 1818 of file SDL_gamecontroller.c.
References SDL_ExtendedGameControllerBind::axis, SDL_GameControllerButtonBind::axis, SDL_GameControllerButtonBind::bindType, SDL_ExtendedGameControllerBind::button, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::hat, SDL_GameControllerButtonBind::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.
SDL_GameControllerButtonBind SDL_GameControllerGetBindForButton | ( | SDL_GameController * | gamecontroller, |
SDL_GameControllerButton | button | ||
) |
Get the SDL joystick layer binding for this controller button mapping
Definition at line 1850 of file SDL_gamecontroller.c.
References SDL_ExtendedGameControllerBind::axis, SDL_GameControllerButtonBind::axis, SDL_GameControllerButtonBind::bindType, SDL_ExtendedGameControllerBind::button, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::hat, SDL_GameControllerButtonBind::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.
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 1694 of file SDL_gamecontroller.c.
References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, 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.
SDL_GameControllerButton SDL_GameControllerGetButtonFromString | ( | const char * | pchString | ) |
turn this string into a button mapping
Definition at line 514 of file SDL_gamecontroller.c.
References map_StringForControllerButton, SDL_CONTROLLER_BUTTON_INVALID, and SDL_strcasecmp.
Referenced by SDL_PrivateGameControllerParseElement().
SDL_Joystick* SDL_GameControllerGetJoystick | ( | SDL_GameController * | gamecontroller | ) |
Get the underlying joystick object used by a controller
Definition at line 1784 of file SDL_gamecontroller.c.
References NULL.
Referenced by SDL_GameControllerGetPlayerIndex(), SDL_GameControllerGetProduct(), SDL_GameControllerGetProductVersion(), SDL_GameControllerGetVendor(), SDL_GameControllerName(), and SDL_GameControllerRumble().
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 1745 of file SDL_gamecontroller.c.
References SDL_GameControllerGetJoystick(), and SDL_JoystickGetPlayerIndex.
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 1757 of file SDL_gamecontroller.c.
References SDL_GameControllerGetJoystick(), and SDL_JoystickGetProduct.
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 1763 of file SDL_gamecontroller.c.
References SDL_GameControllerGetJoystick(), and SDL_JoystickGetProductVersion.
const char* SDL_GameControllerGetStringForAxis | ( | SDL_GameControllerAxis | axis | ) |
turn this axis enum into a string mapping
Definition at line 484 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 530 of file SDL_gamecontroller.c.
References axis, map_StringForControllerButton, NULL, SDL_CONTROLLER_BUTTON_INVALID, and SDL_CONTROLLER_BUTTON_MAX.
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 1751 of file SDL_gamecontroller.c.
References SDL_GameControllerGetJoystick(), and SDL_JoystickGetVendor.
char* SDL_GameControllerMapping | ( | SDL_GameController * | gamecontroller | ) |
Get a mapping string for an open GameController
Definition at line 1284 of file SDL_gamecontroller.c.
References NULL, and SDL_GameControllerMappingForGUID().
char* SDL_GameControllerMappingForDeviceIndex | ( | int | joystick_index | ) |
Get the mapping of a game controller. This can be called before any controllers are opened.
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 1419 of file SDL_gamecontroller.c.
References ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_JoystickGetDeviceGUID, SDL_JoystickGetGUIDString, SDL_LockJoysticks, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_snprintf, SDL_strlen, and SDL_UnlockJoysticks.
char* SDL_GameControllerMappingForGUID | ( | SDL_JoystickGUID | guid | ) |
Get a mapping string for a GUID
Definition at line 1260 of file SDL_gamecontroller.c.
References ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_FALSE, SDL_JoystickGetGUIDString, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMappingForGUID(), SDL_snprintf, and SDL_strlen.
Referenced by SDL_GameControllerMapping().
char* SDL_GameControllerMappingForIndex | ( | int | mapping_index | ) |
Get the mapping at a particular index.
Definition at line 1227 of file SDL_gamecontroller.c.
References ControllerMapping_t::guid, ControllerMapping_t::mapping, ControllerMapping_t::name, ControllerMapping_t::next, NULL, SDL_JoystickGetGUIDString, SDL_malloc, SDL_memcmp, SDL_OutOfMemory, SDL_snprintf, and SDL_strlen.
const char* SDL_GameControllerName | ( | SDL_GameController * | gamecontroller | ) |
Return the name for this currently opened controller
Definition at line 1732 of file SDL_gamecontroller.c.
References NULL, SDL_GameControllerGetJoystick(), SDL_JoystickName, and SDL_strcmp.
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 1399 of file SDL_gamecontroller.c.
References ControllerMapping_t::name, NULL, SDL_JoystickNameForIndex, SDL_PrivateGetControllerMapping(), and SDL_strcmp.
int SDL_GameControllerNumMappings | ( | void | ) |
Get the number of mappings installed
Definition at line 1209 of file SDL_gamecontroller.c.
References ControllerMapping_t::guid, ControllerMapping_t::next, and SDL_memcmp.
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 1541 of file SDL_gamecontroller.c.
References 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.
int SDL_GameControllerRumble | ( | SDL_GameController * | gamecontroller, |
Uint16 | low_frequency_rumble, | ||
Uint16 | high_frequency_rumble, | ||
Uint32 | duration_ms | ||
) |
Trigger a rumble effect Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.
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 |
Definition at line 1879 of file SDL_gamecontroller.c.
References SDL_GameControllerGetJoystick(), and SDL_JoystickRumble.
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 1625 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 1464 of file SDL_gamecontroller.c.
References SDL_FALSE, SDL_PrivateGetControllerMapping(), and SDL_TRUE.
Referenced by SDL_GameControllerEventWatcher(), and SDL_GameControllerInit().