My Project
SDL_joystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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 
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 
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 
81 typedef Sint32 SDL_JoystickID;
82 
83 typedef enum
84 {
85  SDL_JOYSTICK_TYPE_UNKNOWN,
86  SDL_JOYSTICK_TYPE_GAMECONTROLLER,
87  SDL_JOYSTICK_TYPE_WHEEL,
88  SDL_JOYSTICK_TYPE_ARCADE_STICK,
89  SDL_JOYSTICK_TYPE_FLIGHT_STICK,
90  SDL_JOYSTICK_TYPE_DANCE_PAD,
91  SDL_JOYSTICK_TYPE_GUITAR,
92  SDL_JOYSTICK_TYPE_DRUM_KIT,
93  SDL_JOYSTICK_TYPE_ARCADE_PAD,
94  SDL_JOYSTICK_TYPE_THROTTLE
95 } SDL_JoystickType;
96 
97 typedef enum
98 {
99  SDL_JOYSTICK_POWER_UNKNOWN = -1,
100  SDL_JOYSTICK_POWER_EMPTY, /* <= 5% */
101  SDL_JOYSTICK_POWER_LOW, /* <= 20% */
102  SDL_JOYSTICK_POWER_MEDIUM, /* <= 70% */
103  SDL_JOYSTICK_POWER_FULL, /* <= 100% */
104  SDL_JOYSTICK_POWER_WIRED,
105  SDL_JOYSTICK_POWER_MAX
106 } SDL_JoystickPowerLevel;
107 
108 /* Set max recognized G-force from accelerometer
109  See src/joystick/uikit/SDL_sysjoystick.m for notes on why this is needed
110  */
111 #define SDL_IPHONE_MAX_GFORCE 5.0
112 
113 
114 /* Function prototypes */
115 
126 extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
127 extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void);
128 
132 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
133 
139 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
140 
145 extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index);
146 
151 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
152 
158 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
159 
165 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
166 
172 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
173 
178 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
179 
185 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
186 
196 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
197 
201 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID instance_id);
202 
206 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromPlayerIndex(int player_index);
207 
212 extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type,
213  int naxes,
214  int nbuttons,
215  int nhats);
216 
221 extern DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index);
222 
226 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index);
227 
238 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value);
239 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualButton(SDL_Joystick *joystick, int button, Uint8 value);
240 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value);
241 
246 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick *joystick);
247 
253 extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick);
254 
258 extern DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick *joystick, int player_index);
259 
263 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick *joystick);
264 
269 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick);
270 
275 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick);
276 
281 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joystick);
282 
288 extern DECLSPEC const char * SDLCALL SDL_JoystickGetSerial(SDL_Joystick *joystick);
289 
293 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joystick);
294 
299 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
300 
304 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
305 
309 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick *joystick);
310 
314 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick *joystick);
315 
319 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick);
320 
327 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick);
328 
332 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick);
333 
337 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick);
338 
345 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
346 
356 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
357 
358 #define SDL_JOYSTICK_AXIS_MAX 32767
359 #define SDL_JOYSTICK_AXIS_MIN -32768
367 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick,
368  int axis);
369 
379 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick,
380  int axis, Sint16 *state);
381 
385 /* @{ */
386 #define SDL_HAT_CENTERED 0x00
387 #define SDL_HAT_UP 0x01
388 #define SDL_HAT_RIGHT 0x02
389 #define SDL_HAT_DOWN 0x04
390 #define SDL_HAT_LEFT 0x08
391 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
392 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
393 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
394 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
395 /* @} */
396 
413 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick,
414  int hat);
415 
423 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick,
424  int ball, int *dx, int *dy);
425 
431 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick,
432  int button);
433 
445 extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
446 
458 extern DECLSPEC int SDLCALL SDL_JoystickRumbleTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms);
459 
467 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickHasLED(SDL_Joystick *joystick);
468 
479 extern DECLSPEC int SDLCALL SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue);
480 
484 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick);
485 
489 extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick *joystick);
490 
491 /* Ends C function definitions when using C++ */
492 #ifdef __cplusplus
493 }
494 #endif
495 #include "close_code.h"
496 
497 #endif /* SDL_joystick_h_ */
498 
499 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC int SDLCALL SDL_JoystickRumbleTriggers(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick)
DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, int hat)
DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_NumJoysticks(void)
DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index)
DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state)
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
DECLSPEC void SDLCALL SDL_JoystickUpdate(void)
DECLSPEC void SDLCALL SDL_LockJoysticks(void)
DECLSPEC int SDLCALL SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue)
DECLSPEC int SDLCALL SDL_JoystickEventState(int state)
DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick *joystick, int player_index)
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index)
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromPlayerIndex(int player_index)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index)
DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value)
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index)
DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index)
DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick)
DECLSPEC SDL_bool SDLCALL SDL_JoystickHasLED(SDL_Joystick *joystick)
DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick)
DECLSPEC const char *SDLCALL SDL_JoystickGetSerial(SDL_Joystick *joystick)
DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, int button)
DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick *joystick)
DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis)
DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type, int naxes, int nbuttons, int nhats)
DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joystick)
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID instance_id)
DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index)
DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index)
DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joystick)
Definition: SDL_joystick.h:70