My Project
SDL_joystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2019 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 /* Function prototypes */
109 
120 extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
121 extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void);
122 
126 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
127 
133 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
134 
139 extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index);
140 
145 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
146 
152 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
153 
159 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
160 
166 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
167 
172 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
173 
179 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
180 
190 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
191 
195 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
196 
201 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
202 
208 extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick * joystick);
209 
213 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
214 
219 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
220 
225 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
226 
231 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
232 
236 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
237 
242 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
243 
247 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
248 
252 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
253 
257 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
258 
262 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
263 
270 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
271 
275 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
276 
280 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
281 
288 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
289 
299 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
300 
301 #define SDL_JOYSTICK_AXIS_MAX 32767
302 #define SDL_JOYSTICK_AXIS_MIN -32768
303 
310 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
311  int axis);
312 
322 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
323  int axis, Sint16 *state);
324 
328 /* @{ */
329 #define SDL_HAT_CENTERED 0x00
330 #define SDL_HAT_UP 0x01
331 #define SDL_HAT_RIGHT 0x02
332 #define SDL_HAT_DOWN 0x04
333 #define SDL_HAT_LEFT 0x08
334 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
335 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
336 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
337 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
338 /* @} */
339 
356 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
357  int hat);
358 
366 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
367  int ball, int *dx, int *dy);
368 
374 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
375  int button);
376 
388 extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
389 
393 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
394 
398 extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick);
399 
400 /* Ends C function definitions when using C++ */
401 #ifdef __cplusplus
402 }
403 #endif
404 #include "close_code.h"
405 
406 #endif /* SDL_joystick_h_ */
407 
408 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID)
DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick, int axis, Sint16 *state)
DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index)
DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis)
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
DECLSPEC void SDLCALL SDL_LockJoysticks(void)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index)
DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick *joystick)
DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick *joystick)
DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index)
DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, int button)
Definition: SDL_joystick.h:70
DECLSPEC int SDLCALL SDL_NumJoysticks(void)
DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick *joystick)
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index)
DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index)
DECLSPEC int SDLCALL SDL_JoystickEventState(int state)
DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index)
DECLSPEC void SDLCALL SDL_JoystickUpdate(void)
DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, int hat)
DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index)
DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick *joystick)
DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index)
DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick)
DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid)