My Project
SDL_joystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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,
101  SDL_JOYSTICK_POWER_LOW,
102  SDL_JOYSTICK_POWER_MEDIUM,
103  SDL_JOYSTICK_POWER_FULL,
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 SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
140 
146 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
147 
153 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
154 
160 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
161 
166 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
167 
173 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
174 
184 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
185 
189 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
190 
195 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
196 
200 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
201 
206 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
207 
212 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
213 
218 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
219 
223 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
224 
229 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
230 
234 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
235 
239 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
240 
244 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
245 
249 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
250 
257 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
258 
262 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
263 
267 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
268 
275 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
276 
286 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
287 
288 #define SDL_JOYSTICK_AXIS_MAX 32767
289 #define SDL_JOYSTICK_AXIS_MIN -32768
290 
297 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
298  int axis);
299 
309 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
310  int axis, Sint16 *state);
311 
315 /* @{ */
316 #define SDL_HAT_CENTERED 0x00
317 #define SDL_HAT_UP 0x01
318 #define SDL_HAT_RIGHT 0x02
319 #define SDL_HAT_DOWN 0x04
320 #define SDL_HAT_LEFT 0x08
321 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
322 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
323 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
324 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
325 /* @} */
326 
343 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
344  int hat);
345 
353 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
354  int ball, int *dx, int *dy);
355 
361 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
362  int button);
363 
367 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
368 
372 extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick);
373 
374 /* Ends C function definitions when using C++ */
375 #ifdef __cplusplus
376 }
377 #endif
378 #include "close_code.h"
379 
380 #endif /* SDL_joystick_h_ */
381 
382 /* 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 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 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 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)