include/SDL_joystick.h

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