2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
23 * \file SDL_gamecontroller.h
25 * Include file for SDL game controller event handling
28 #ifndef SDL_gamecontroller_h_
29 #define SDL_gamecontroller_h_
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_rwops.h"
34 #include "SDL_joystick.h"
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
43 * \file SDL_gamecontroller.h
45 * In order to use these functions, SDL_Init() must have been called
46 * with the ::SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system
47 * for game controllers, and load appropriate drivers.
49 * If you would like to receive controller updates while the application
50 * is in the background, you should set the following hint before calling
51 * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
55 * The gamecontroller structure used to identify an SDL game controller
57 struct _SDL_GameController;
58 typedef struct _SDL_GameController SDL_GameController;
63 SDL_CONTROLLER_BINDTYPE_NONE = 0,
64 SDL_CONTROLLER_BINDTYPE_BUTTON,
65 SDL_CONTROLLER_BINDTYPE_AXIS,
66 SDL_CONTROLLER_BINDTYPE_HAT
67 } SDL_GameControllerBindType;
70 * Get the SDL joystick layer binding for this controller button/axis mapping
72 typedef struct SDL_GameControllerButtonBind
74 SDL_GameControllerBindType bindType;
85 } SDL_GameControllerButtonBind;
89 * To count the number of game controllers in the system for the following:
90 * int nJoysticks = SDL_NumJoysticks();
91 * int nGameControllers = 0;
92 * for (int i = 0; i < nJoysticks; i++) {
93 * if (SDL_IsGameController(i)) {
98 * 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:
101 * 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.
102 * Under Windows there is a reserved GUID of "xinput" that covers any XInput devices.
103 * The mapping format for joystick is:
104 * bX - a joystick button, index X
105 * hX.Y - hat X with value Y
106 * aX - axis X of the joystick
107 * Buttons can be used as a controller axis and vice versa.
109 * This string shows an example of a valid mapping for a controller
110 * "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",
115 * Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current SDL_GetPlatform()
116 * A community sourced database of controllers is available at https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt
118 * If \c freerw is non-zero, the stream will be closed after being read.
120 * \return number of mappings added, -1 on error
122 extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw, int freerw);
125 * Load a set of mappings from a file, filtered by the current SDL_GetPlatform()
129 #define SDL_GameControllerAddMappingsFromFile(file) SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)
132 * Add or update an existing mapping configuration
134 * \return 1 if mapping is added, 0 if updated, -1 on error
136 extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping(const char* mappingString);
139 * Get the number of mappings installed
141 * \return the number of mappings
143 extern DECLSPEC int SDLCALL SDL_GameControllerNumMappings(void);
146 * Get the mapping at a particular index.
148 * \return the mapping string. Must be freed with SDL_free(). Returns NULL if the index is out of range.
150 extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForIndex(int mapping_index);
153 * Get a mapping string for a GUID
155 * \return the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available
157 extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID(SDL_JoystickGUID guid);
160 * Get a mapping string for an open GameController
162 * \return the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available
164 extern DECLSPEC char * SDLCALL SDL_GameControllerMapping(SDL_GameController * gamecontroller);
167 * Is the joystick on this index supported by the game controller interface?
169 extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index);
172 * Get the implementation dependent name of a game controller.
173 * This can be called before any controllers are opened.
174 * If no name can be found, this function returns NULL.
176 extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_index);
179 * Get the mapping of a game controller.
180 * This can be called before any controllers are opened.
182 * \return the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available
184 extern DECLSPEC char *SDLCALL SDL_GameControllerMappingForDeviceIndex(int joystick_index);
187 * Open a game controller for use.
188 * The index passed as an argument refers to the N'th game controller on the system.
189 * This index is not the value which will identify this controller in future
190 * controller events. The joystick's instance id (::SDL_JoystickID) will be
191 * used there instead.
193 * \return A controller identifier, or NULL if an error occurred.
195 extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_index);
198 * Return the SDL_GameController associated with an instance id.
200 extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromInstanceID(SDL_JoystickID joyid);
203 * Return the name for this currently opened controller
205 extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *gamecontroller);
208 * Get the player index of an opened game controller, or -1 if it's not available
210 * For XInput controllers this returns the XInput user index.
212 extern DECLSPEC int SDLCALL SDL_GameControllerGetPlayerIndex(SDL_GameController *gamecontroller);
215 * Get the USB vendor ID of an opened controller, if available.
216 * If the vendor ID isn't available this function returns 0.
218 extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetVendor(SDL_GameController * gamecontroller);
221 * Get the USB product ID of an opened controller, if available.
222 * If the product ID isn't available this function returns 0.
224 extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProduct(SDL_GameController * gamecontroller);
227 * Get the product version of an opened controller, if available.
228 * If the product version isn't available this function returns 0.
230 extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProductVersion(SDL_GameController * gamecontroller);
233 * Returns SDL_TRUE if the controller has been opened and currently connected,
234 * or SDL_FALSE if it has not.
236 extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameController *gamecontroller);
239 * Get the underlying joystick object used by a controller
241 extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller);
244 * Enable/disable controller event polling.
246 * If controller events are disabled, you must call SDL_GameControllerUpdate()
247 * yourself and check the state of the controller when you want controller
250 * The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
252 extern DECLSPEC int SDLCALL SDL_GameControllerEventState(int state);
255 * Update the current state of the open game controllers.
257 * This is called automatically by the event loop if any game controller
258 * events are enabled.
260 extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
264 * The list of axes available from a controller
266 * Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX,
267 * and are centered within ~8000 of zero, though advanced UI will allow users to set
268 * or autodetect the dead zone, which varies between controllers.
270 * Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
274 SDL_CONTROLLER_AXIS_INVALID = -1,
275 SDL_CONTROLLER_AXIS_LEFTX,
276 SDL_CONTROLLER_AXIS_LEFTY,
277 SDL_CONTROLLER_AXIS_RIGHTX,
278 SDL_CONTROLLER_AXIS_RIGHTY,
279 SDL_CONTROLLER_AXIS_TRIGGERLEFT,
280 SDL_CONTROLLER_AXIS_TRIGGERRIGHT,
281 SDL_CONTROLLER_AXIS_MAX
282 } SDL_GameControllerAxis;
285 * turn this string into a axis mapping
287 extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromString(const char *pchString);
290 * turn this axis enum into a string mapping
292 extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameControllerAxis axis);
295 * Get the SDL joystick layer binding for this controller button mapping
297 extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
298 SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller,
299 SDL_GameControllerAxis axis);
302 * Get the current state of an axis control on a game controller.
304 * The state is a value ranging from -32768 to 32767 (except for the triggers,
305 * which range from 0 to 32767).
307 * The axis indices start at index 0.
309 extern DECLSPEC Sint16 SDLCALL
310 SDL_GameControllerGetAxis(SDL_GameController *gamecontroller,
311 SDL_GameControllerAxis axis);
314 * The list of buttons available from a controller
318 SDL_CONTROLLER_BUTTON_INVALID = -1,
319 SDL_CONTROLLER_BUTTON_A,
320 SDL_CONTROLLER_BUTTON_B,
321 SDL_CONTROLLER_BUTTON_X,
322 SDL_CONTROLLER_BUTTON_Y,
323 SDL_CONTROLLER_BUTTON_BACK,
324 SDL_CONTROLLER_BUTTON_GUIDE,
325 SDL_CONTROLLER_BUTTON_START,
326 SDL_CONTROLLER_BUTTON_LEFTSTICK,
327 SDL_CONTROLLER_BUTTON_RIGHTSTICK,
328 SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
329 SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
330 SDL_CONTROLLER_BUTTON_DPAD_UP,
331 SDL_CONTROLLER_BUTTON_DPAD_DOWN,
332 SDL_CONTROLLER_BUTTON_DPAD_LEFT,
333 SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
334 SDL_CONTROLLER_BUTTON_MAX
335 } SDL_GameControllerButton;
338 * turn this string into a button mapping
340 extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFromString(const char *pchString);
343 * turn this button enum into a string mapping
345 extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_GameControllerButton button);
348 * Get the SDL joystick layer binding for this controller button mapping
350 extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
351 SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller,
352 SDL_GameControllerButton button);
356 * Get the current state of a button on a game controller.
358 * The button indices start at index 0.
360 extern DECLSPEC Uint8 SDLCALL SDL_GameControllerGetButton(SDL_GameController *gamecontroller,
361 SDL_GameControllerButton button);
364 * Trigger a rumble effect
365 * Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.
367 * \param gamecontroller The controller to vibrate
368 * \param low_frequency_rumble The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
369 * \param high_frequency_rumble The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
370 * \param duration_ms The duration of the rumble effect, in milliseconds
372 * \return 0, or -1 if rumble isn't supported on this joystick
374 extern DECLSPEC int SDLCALL SDL_GameControllerRumble(SDL_GameController *gamecontroller, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
377 * Close a controller previously opened with SDL_GameControllerOpen().
379 extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecontroller);
382 /* Ends C function definitions when using C++ */
386 #include "close_code.h"
388 #endif /* SDL_gamecontroller_h_ */
390 /* vi: set ts=4 sw=4 expandtab: */