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 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]; 72 } SDL_JoystickGUID; 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 */ 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 109 /* Function prototypes */ 110 111 /** 112 * Locking for multi-threaded access to the joystick API 113 * 114 * If you are using the joystick API or handling events from multiple threads 115 * you should use these locking functions to protect access to the joysticks. 116 * 117 * In particular, you are guaranteed that the joystick list won't change, so 118 * the API functions that take a joystick index will be valid, and joystick 119 * and game controller events will not be delivered. 120 */ 121 extern DECLSPEC void SDLCALL SDL_LockJoysticks(void); 122 extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void); 123 124 /** 125 * Count the number of joysticks attached to the system right now 126 */ 127 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void); 128 129 /** 130 * Get the implementation dependent name of a joystick. 131 * This can be called before any joysticks are opened. 132 * If no name can be found, this function returns NULL. 133 */ 134 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index); 135 136 /** 137 * Get the player index of a joystick, or -1 if it's not available 138 * This can be called before any joysticks are opened. 139 */ 140 extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index); 141 142 /** 143 * Return the GUID for the joystick at this index 144 * This can be called before any joysticks are opened. 145 */ 146 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index); 147 148 /** 149 * Get the USB vendor ID of a joystick, if available. 150 * This can be called before any joysticks are opened. 151 * If the vendor ID isn't available this function returns 0. 152 */ 153 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index); 154 155 /** 156 * Get the USB product ID of a joystick, if available. 157 * This can be called before any joysticks are opened. 158 * If the product ID isn't available this function returns 0. 159 */ 160 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index); 161 162 /** 163 * Get the product version of a joystick, if available. 164 * This can be called before any joysticks are opened. 165 * If the product version isn't available this function returns 0. 166 */ 167 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index); 168 169 /** 170 * Get the type of a joystick, if available. 171 * This can be called before any joysticks are opened. 172 */ 173 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index); 174 175 /** 176 * Get the instance ID of a joystick. 177 * This can be called before any joysticks are opened. 178 * If the index is out of range, this function will return -1. 179 */ 180 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index); 181 182 /** 183 * Open a joystick for use. 184 * The index passed as an argument refers to the N'th joystick on the system. 185 * This index is not the value which will identify this joystick in future 186 * joystick events. The joystick's instance id (::SDL_JoystickID) will be used 187 * there instead. 188 * 189 * \return A joystick identifier, or NULL if an error occurred. 190 */ 191 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index); 192 193 /** 194 * Return the SDL_Joystick associated with an instance id. 195 */ 196 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID instance_id); 197 198 /** 199 * Return the SDL_Joystick associated with a player index. 200 */ 201 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromPlayerIndex(int player_index); 202 203 /** 204 * Attaches a new virtual joystick. 205 * Returns the joystick's device index, or -1 if an error occurred. 206 */ 207 extern DECLSPEC int SDLCALL SDL_JoystickAttachVirtual(SDL_JoystickType type, 208 int naxes, 209 int nbuttons, 210 int nhats); 211 212 /** 213 * Detaches a virtual joystick 214 * Returns 0 on success, or -1 if an error occurred. 215 */ 216 extern DECLSPEC int SDLCALL SDL_JoystickDetachVirtual(int device_index); 217 218 /** 219 * Indicates whether or not a virtual-joystick is at a given device index. 220 */ 221 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index); 222 223 /** 224 * Set values on an opened, virtual-joystick's controls. 225 * Please note that values set here will not be applied until the next 226 * call to SDL_JoystickUpdate, which can either be called directly, 227 * or can be called indirectly through various other SDL APIS, 228 * including, but not limited to the following: SDL_PollEvent, 229 * SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent. 230 * 231 * Returns 0 on success, -1 on error. 232 */ 233 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick * joystick, int axis, Sint16 value); 234 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualButton(SDL_Joystick * joystick, int button, Uint8 value); 235 extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualHat(SDL_Joystick * joystick, int hat, Uint8 value); 236 237 /** 238 * Return the name for this currently opened joystick. 239 * If no name can be found, this function returns NULL. 240 */ 241 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick); 242 243 /** 244 * Get the player index of an opened joystick, or -1 if it's not available 245 * 246 * For XInput controllers this returns the XInput user index. 247 */ 248 extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick * joystick); 249 250 /** 251 * Set the player index of an opened joystick 252 */ 253 extern DECLSPEC void SDLCALL SDL_JoystickSetPlayerIndex(SDL_Joystick * joystick, int player_index); 254 255 /** 256 * Return the GUID for this opened joystick 257 */ 258 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick); 259 260 /** 261 * Get the USB vendor ID of an opened joystick, if available. 262 * If the vendor ID isn't available this function returns 0. 263 */ 264 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick); 265 266 /** 267 * Get the USB product ID of an opened joystick, if available. 268 * If the product ID isn't available this function returns 0. 269 */ 270 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick); 271 272 /** 273 * Get the product version of an opened joystick, if available. 274 * If the product version isn't available this function returns 0. 275 */ 276 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick); 277 278 /** 279 * Get the type of an opened joystick. 280 */ 281 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick); 282 283 /** 284 * Return a string representation for this guid. pszGUID must point to at least 33 bytes 285 * (32 for the string plus a NULL terminator). 286 */ 287 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID); 288 289 /** 290 * Convert a string into a joystick guid 291 */ 292 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID); 293 294 /** 295 * Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not. 296 */ 297 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick); 298 299 /** 300 * Get the instance ID of an opened joystick or -1 if the joystick is invalid. 301 */ 302 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick); 303 304 /** 305 * Get the number of general axis controls on a joystick. 306 */ 307 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick); 308 309 /** 310 * Get the number of trackballs on a joystick. 311 * 312 * Joystick trackballs have only relative motion events associated 313 * with them and their state cannot be polled. 314 */ 315 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick); 316 317 /** 318 * Get the number of POV hats on a joystick. 319 */ 320 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick); 321 322 /** 323 * Get the number of buttons on a joystick. 324 */ 325 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick); 326 327 /** 328 * Update the current state of the open joysticks. 329 * 330 * This is called automatically by the event loop if any joystick 331 * events are enabled. 332 */ 333 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); 334 335 /** 336 * Enable/disable joystick event polling. 337 * 338 * If joystick events are disabled, you must call SDL_JoystickUpdate() 339 * yourself and check the state of the joystick when you want joystick 340 * information. 341 * 342 * The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE. 343 */ 344 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state); 345 346 #define SDL_JOYSTICK_AXIS_MAX 32767 347 #define SDL_JOYSTICK_AXIS_MIN -32768 348 /** 349 * Get the current state of an axis control on a joystick. 350 * 351 * The state is a value ranging from -32768 to 32767. 352 * 353 * The axis indices start at index 0. 354 */ 355 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick, 356 int axis); 357 358 /** 359 * Get the initial state of an axis control on a joystick. 360 * 361 * The state is a value ranging from -32768 to 32767. 362 * 363 * The axis indices start at index 0. 364 * 365 * \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not. 366 */ 367 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick, 368 int axis, Sint16 *state); 369 370 /** 371 * \name Hat positions 372 */ 373 /* @{ */ 374 #define SDL_HAT_CENTERED 0x00 375 #define SDL_HAT_UP 0x01 376 #define SDL_HAT_RIGHT 0x02 377 #define SDL_HAT_DOWN 0x04 378 #define SDL_HAT_LEFT 0x08 379 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) 380 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) 381 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) 382 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) 383 /* @} */ 384 385 /** 386 * Get the current state of a POV hat on a joystick. 387 * 388 * The hat indices start at index 0. 389 * 390 * \return The return value is one of the following positions: 391 * - ::SDL_HAT_CENTERED 392 * - ::SDL_HAT_UP 393 * - ::SDL_HAT_RIGHT 394 * - ::SDL_HAT_DOWN 395 * - ::SDL_HAT_LEFT 396 * - ::SDL_HAT_RIGHTUP 397 * - ::SDL_HAT_RIGHTDOWN 398 * - ::SDL_HAT_LEFTUP 399 * - ::SDL_HAT_LEFTDOWN 400 */ 401 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick, 402 int hat); 403 404 /** 405 * Get the ball axis change since the last poll. 406 * 407 * \return 0, or -1 if you passed it invalid parameters. 408 * 409 * The ball indices start at index 0. 410 */ 411 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick, 412 int ball, int *dx, int *dy); 413 414 /** 415 * Get the current state of a button on a joystick. 416 * 417 * The button indices start at index 0. 418 */ 419 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick, 420 int button); 421 422 /** 423 * Trigger a rumble effect 424 * Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling. 425 * 426 * \param joystick The joystick to vibrate 427 * \param low_frequency_rumble The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF 428 * \param high_frequency_rumble The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF 429 * \param duration_ms The duration of the rumble effect, in milliseconds 430 * 431 * \return 0, or -1 if rumble isn't supported on this joystick 432 */ 433 extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms); 434 435 /** 436 * Close a joystick previously opened with SDL_JoystickOpen(). 437 */ 438 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick); 439 440 /** 441 * Return the battery level of this joystick 442 */ 443 extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick); 444 445 /* Ends C function definitions when using C++ */ 446 #ifdef __cplusplus 447 } 448 #endif 449 #include "close_code.h" 450 451 #endif /* SDL_joystick_h_ */ 452 453 /* vi: set ts=4 sw=4 expandtab: */ 454