SDL  2.0
SDL_joystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>
4 
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.
8 
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:
12 
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.
20 */
21 
22 /**
23  * \file SDL_joystick.h
24  *
25  * Include file for SDL joystick event handling
26  *
27  * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
28  * behind a device_index changing as joysticks are plugged and unplugged.
29  *
30  * The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
31  * then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
32  *
33  * The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
34  * the device (a X360 wired controller for example). This identifier is platform dependent.
35  *
36  *
37  */
38 
39 #ifndef SDL_joystick_h_
40 #define SDL_joystick_h_
41 
42 #include "SDL_stdinc.h"
43 #include "SDL_error.h"
44 
45 #include "begin_code.h"
46 /* Set up for C function definitions, even when using C++ */
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 /**
52  * \file SDL_joystick.h
53  *
54  * In order to use these functions, SDL_Init() must have been called
55  * with the ::SDL_INIT_JOYSTICK flag. This causes SDL to scan the system
56  * for joysticks, and load appropriate drivers.
57  *
58  * If you would like to receive joystick updates while the application
59  * is in the background, you should set the following hint before calling
60  * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
61  */
62 
63 /**
64  * The joystick structure used to identify an SDL joystick
65  */
66 struct _SDL_Joystick;
67 typedef struct _SDL_Joystick SDL_Joystick;
68 
69 /* A structure that encodes the stable unique id for a joystick device */
70 typedef struct {
71  Uint8 data[16];
73 
74 /**
75  * This is a unique ID for a joystick for the time it is connected to the system,
76  * and is never reused for the lifetime of the application. If the joystick is
77  * disconnected and reconnected, it will get a new ID.
78  *
79  * The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
80  */
82 
83 typedef enum
84 {
96 
97 typedef enum
98 {
107 
108 /* Function prototypes */
109 /**
110  * Count the number of joysticks attached to the system right now
111  */
112 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
113 
114 /**
115  * Get the implementation dependent name of a joystick.
116  * This can be called before any joysticks are opened.
117  * If no name can be found, this function returns NULL.
118  */
119 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
120 
121 /**
122  * Return the GUID for the joystick at this index
123  * This can be called before any joysticks are opened.
124  */
126 
127 /**
128  * Get the USB vendor ID of a joystick, if available.
129  * This can be called before any joysticks are opened.
130  * If the vendor ID isn't available this function returns 0.
131  */
132 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
133 
134 /**
135  * Get the USB product ID of a joystick, if available.
136  * This can be called before any joysticks are opened.
137  * If the product ID isn't available this function returns 0.
138  */
139 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
140 
141 /**
142  * Get the product version of a joystick, if available.
143  * This can be called before any joysticks are opened.
144  * If the product version isn't available this function returns 0.
145  */
147 
148 /**
149  * Get the type of a joystick, if available.
150  * This can be called before any joysticks are opened.
151  */
153 
154 /**
155  * Get the instance ID of a joystick.
156  * This can be called before any joysticks are opened.
157  * If the index is out of range, this function will return -1.
158  */
159 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
160 
161 /**
162  * Open a joystick for use.
163  * The index passed as an argument refers to the N'th joystick on the system.
164  * This index is not the value which will identify this joystick in future
165  * joystick events. The joystick's instance id (::SDL_JoystickID) will be used
166  * there instead.
167  *
168  * \return A joystick identifier, or NULL if an error occurred.
169  */
170 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
171 
172 /**
173  * Return the SDL_Joystick associated with an instance id.
174  */
175 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
176 
177 /**
178  * Return the name for this currently opened joystick.
179  * If no name can be found, this function returns NULL.
180  */
181 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
182 
183 /**
184  * Return the GUID for this opened joystick
185  */
186 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
187 
188 /**
189  * Get the USB vendor ID of an opened joystick, if available.
190  * If the vendor ID isn't available this function returns 0.
191  */
192 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
193 
194 /**
195  * Get the USB product ID of an opened joystick, if available.
196  * If the product ID isn't available this function returns 0.
197  */
198 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
199 
200 /**
201  * Get the product version of an opened joystick, if available.
202  * If the product version isn't available this function returns 0.
203  */
204 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
205 
206 /**
207  * Get the type of an opened joystick.
208  */
209 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
210 
211 /**
212  * Return a string representation for this guid. pszGUID must point to at least 33 bytes
213  * (32 for the string plus a NULL terminator).
214  */
215 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
216 
217 /**
218  * Convert a string into a joystick guid
219  */
221 
222 /**
223  * Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
224  */
225 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
226 
227 /**
228  * Get the instance ID of an opened joystick or -1 if the joystick is invalid.
229  */
230 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
231 
232 /**
233  * Get the number of general axis controls on a joystick.
234  */
235 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
236 
237 /**
238  * Get the number of trackballs on a joystick.
239  *
240  * Joystick trackballs have only relative motion events associated
241  * with them and their state cannot be polled.
242  */
243 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
244 
245 /**
246  * Get the number of POV hats on a joystick.
247  */
248 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
249 
250 /**
251  * Get the number of buttons on a joystick.
252  */
253 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
254 
255 /**
256  * Update the current state of the open joysticks.
257  *
258  * This is called automatically by the event loop if any joystick
259  * events are enabled.
260  */
261 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
262 
263 /**
264  * Enable/disable joystick event polling.
265  *
266  * If joystick events are disabled, you must call SDL_JoystickUpdate()
267  * yourself and check the state of the joystick when you want joystick
268  * information.
269  *
270  * The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
271  */
273 
274 #define SDL_JOYSTICK_AXIS_MAX 32767
275 #define SDL_JOYSTICK_AXIS_MIN -32768
276 /**
277  * Get the current state of an axis control on a joystick.
278  *
279  * The state is a value ranging from -32768 to 32767.
280  *
281  * The axis indices start at index 0.
282  */
283 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
284  int axis);
285 
286 /**
287  * Get the initial state of an axis control on a joystick.
288  *
289  * The state is a value ranging from -32768 to 32767.
290  *
291  * The axis indices start at index 0.
292  *
293  * \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
294  */
295 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
296  int axis, Sint16 *state);
297 
298 /**
299  * \name Hat positions
300  */
301 /* @{ */
302 #define SDL_HAT_CENTERED 0x00
303 #define SDL_HAT_UP 0x01
304 #define SDL_HAT_RIGHT 0x02
305 #define SDL_HAT_DOWN 0x04
306 #define SDL_HAT_LEFT 0x08
307 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
308 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
309 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
310 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
311 /* @} */
312 
313 /**
314  * Get the current state of a POV hat on a joystick.
315  *
316  * The hat indices start at index 0.
317  *
318  * \return The return value is one of the following positions:
319  * - ::SDL_HAT_CENTERED
320  * - ::SDL_HAT_UP
321  * - ::SDL_HAT_RIGHT
322  * - ::SDL_HAT_DOWN
323  * - ::SDL_HAT_LEFT
324  * - ::SDL_HAT_RIGHTUP
325  * - ::SDL_HAT_RIGHTDOWN
326  * - ::SDL_HAT_LEFTUP
327  * - ::SDL_HAT_LEFTDOWN
328  */
329 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
330  int hat);
331 
332 /**
333  * Get the ball axis change since the last poll.
334  *
335  * \return 0, or -1 if you passed it invalid parameters.
336  *
337  * The ball indices start at index 0.
338  */
339 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
340  int ball, int *dx, int *dy);
341 
342 /**
343  * Get the current state of a button on a joystick.
344  *
345  * The button indices start at index 0.
346  */
347 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
348  int button);
349 
350 /**
351  * Close a joystick previously opened with SDL_JoystickOpen().
352  */
353 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
354 
355 /**
356  * Return the battery level of this joystick
357  */
359 
360 /* Ends C function definitions when using C++ */
361 #ifdef __cplusplus
362 }
363 #endif
364 #include "close_code.h"
365 
366 #endif /* SDL_joystick_h_ */
367 
368 /* vi: set ts=4 sw=4 expandtab: */
SDL_JoystickGUID SDL_JoystickGetGUIDFromString(const char *pchGUID)
SDL_Texture * button
SDL_JoystickType SDL_JoystickGetType(SDL_Joystick *joystick)
struct xkb_state * state
Uint16 SDL_JoystickGetDeviceProduct(int device_index)
SDL_bool SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state)
Definition: SDL_joystick.c:345
void SDL_JoystickClose(SDL_Joystick *joystick)
Definition: SDL_joystick.c:491
Uint16 SDL_JoystickGetProduct(SDL_Joystick *joystick)
Uint16 SDL_JoystickGetVendor(SDL_Joystick *joystick)
SDL_Joystick * SDL_JoystickFromInstanceID(SDL_JoystickID joyid)
Definition: SDL_joystick.c:459
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_Texture * axis
const char * SDL_JoystickNameForIndex(int device_index)
Definition: SDL_joystick.c:111
Uint16 SDL_JoystickGetDeviceProductVersion(int device_index)
SDL_JoystickGUID SDL_JoystickGetGUID(SDL_Joystick *joystick)
SDL_JoystickPowerLevel SDL_JoystickCurrentPowerLevel(SDL_Joystick *joystick)
#define DECLSPEC
Definition: SDL_internal.h:44
SDL_Joystick * SDL_JoystickOpen(int device_index)
Definition: SDL_joystick.c:160
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
uint8_t Uint8
Definition: SDL_stdinc.h:157
Uint16 SDL_JoystickGetProductVersion(SDL_Joystick *joystick)
SDL_JoystickType SDL_JoystickGetDeviceType(int device_index)
int SDL_JoystickEventState(int state)
Definition: SDL_joystick.c:908
int32_t Sint32
Definition: SDL_stdinc.h:175
int SDL_JoystickNumHats(SDL_Joystick *joystick)
Definition: SDL_joystick.c:289
SDL_JoystickPowerLevel
Definition: SDL_joystick.h:97
SDL_JoystickType
Definition: SDL_joystick.h:83
SDL_bool SDL_JoystickGetAttached(SDL_Joystick *joystick)
Definition: SDL_joystick.c:433
const char * SDL_JoystickName(SDL_Joystick *joystick)
Definition: SDL_joystick.c:478
SDL_bool
Definition: SDL_stdinc.h:139
SDL_JoystickID SDL_JoystickGetDeviceInstanceID(int device_index)
Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick, int hat)
Definition: SDL_joystick.c:364
void SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
Uint8 SDL_JoystickGetButton(SDL_Joystick *joystick, int button)
Definition: SDL_joystick.c:412
SDL_JoystickGUID SDL_JoystickGetDeviceGUID(int device_index)
uint16_t Uint16
Definition: SDL_stdinc.h:169
int SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy)
Definition: SDL_joystick.c:384
int SDL_JoystickNumAxes(SDL_Joystick *joystick)
Definition: SDL_joystick.c:277
int SDL_NumJoysticks(void)
Definition: SDL_joystick.c:102
void SDL_JoystickUpdate(void)
Definition: SDL_joystick.c:846
int SDL_JoystickNumBalls(SDL_Joystick *joystick)
Definition: SDL_joystick.c:301
int SDL_JoystickNumButtons(SDL_Joystick *joystick)
Definition: SDL_joystick.c:313
#define SDLCALL
Definition: SDL_internal.h:45
Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis)
Definition: SDL_joystick.c:325
SDL_JoystickID SDL_JoystickInstanceID(SDL_Joystick *joystick)
Definition: SDL_joystick.c:446
Uint16 SDL_JoystickGetDeviceVendor(int device_index)
int16_t Sint16
Definition: SDL_stdinc.h:163