misc/builddeps/win32/sdl/include/SDL2/SDL_joystick.h

   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
  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 /* Function prototypes */
 109
 110 /**
 111  * Locking for multi-threaded access to the joystick API
 112  *
 113  * If you are using the joystick API or handling events from multiple threads
 114  * you should use these locking functions to protect access to the joysticks.
 115  *
 116  * In particular, you are guaranteed that the joystick list won't change, so
 117  * the API functions that take a joystick index will be valid, and joystick
 118  * and game controller events will not be delivered.
 119  */
 120 extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
 121 extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void);
 122
 123 /**
 124  *  Count the number of joysticks attached to the system right now
 125  */
 126 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
 127
 128 /**
 129  *  Get the implementation dependent name of a joystick.
 130  *  This can be called before any joysticks are opened.
 131  *  If no name can be found, this function returns NULL.
 132  */
 133 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
 134
 135 /**
 136  *  Get the player index of a joystick, or -1 if it's not available
 137  *  This can be called before any joysticks are opened.
 138  */
 139 extern DECLSPEC int SDLCALL SDL_JoystickGetDevicePlayerIndex(int device_index);
 140
 141 /**
 142  *  Return the GUID for the joystick at this index
 143  *  This can be called before any joysticks are opened.
 144  */
 145 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
 146
 147 /**
 148  *  Get the USB vendor ID of a joystick, if available.
 149  *  This can be called before any joysticks are opened.
 150  *  If the vendor ID isn't available this function returns 0.
 151  */
 152 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
 153
 154 /**
 155  *  Get the USB product ID of a joystick, if available.
 156  *  This can be called before any joysticks are opened.
 157  *  If the product ID isn't available this function returns 0.
 158  */
 159 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
 160
 161 /**
 162  *  Get the product version of a joystick, if available.
 163  *  This can be called before any joysticks are opened.
 164  *  If the product version isn't available this function returns 0.
 165  */
 166 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
 167
 168 /**
 169  *  Get the type of a joystick, if available.
 170  *  This can be called before any joysticks are opened.
 171  */
 172 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
 173
 174 /**
 175  *  Get the instance ID of a joystick.
 176  *  This can be called before any joysticks are opened.
 177  *  If the index is out of range, this function will return -1.
 178  */
 179 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
 180
 181 /**
 182  *  Open a joystick for use.
 183  *  The index passed as an argument refers to the N'th joystick on the system.
 184  *  This index is not the value which will identify this joystick in future
 185  *  joystick events.  The joystick's instance id (::SDL_JoystickID) will be used
 186  *  there instead.
 187  *
 188  *  \return A joystick identifier, or NULL if an error occurred.
 189  */
 190 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
 191
 192 /**
 193  * Return the SDL_Joystick associated with an instance id.
 194  */
 195 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
 196
 197 /**
 198  *  Return the name for this currently opened joystick.
 199  *  If no name can be found, this function returns NULL.
 200  */
 201 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
 202
 203 /**
 204  *  Get the player index of an opened joystick, or -1 if it's not available
 205  *
 206  *  For XInput controllers this returns the XInput user index.
 207  */
 208 extern DECLSPEC int SDLCALL SDL_JoystickGetPlayerIndex(SDL_Joystick * joystick);
 209
 210 /**
 211  *  Return the GUID for this opened joystick
 212  */
 213 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
 214
 215 /**
 216  *  Get the USB vendor ID of an opened joystick, if available.
 217  *  If the vendor ID isn't available this function returns 0.
 218  */
 219 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
 220
 221 /**
 222  *  Get the USB product ID of an opened joystick, if available.
 223  *  If the product ID isn't available this function returns 0.
 224  */
 225 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
 226
 227 /**
 228  *  Get the product version of an opened joystick, if available.
 229  *  If the product version isn't available this function returns 0.
 230  */
 231 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
 232
 233 /**
 234  *  Get the type of an opened joystick.
 235  */
 236 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
 237
 238 /**
 239  *  Return a string representation for this guid. pszGUID must point to at least 33 bytes
 240  *  (32 for the string plus a NULL terminator).
 241  */
 242 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
 243
 244 /**
 245  *  Convert a string into a joystick guid
 246  */
 247 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
 248
 249 /**
 250  *  Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
 251  */
 252 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
 253
 254 /**
 255  *  Get the instance ID of an opened joystick or -1 if the joystick is invalid.
 256  */
 257 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
 258
 259 /**
 260  *  Get the number of general axis controls on a joystick.
 261  */
 262 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
 263
 264 /**
 265  *  Get the number of trackballs on a joystick.
 266  *
 267  *  Joystick trackballs have only relative motion events associated
 268  *  with them and their state cannot be polled.
 269  */
 270 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
 271
 272 /**
 273  *  Get the number of POV hats on a joystick.
 274  */
 275 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
 276
 277 /**
 278  *  Get the number of buttons on a joystick.
 279  */
 280 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
 281
 282 /**
 283  *  Update the current state of the open joysticks.
 284  *
 285  *  This is called automatically by the event loop if any joystick
 286  *  events are enabled.
 287  */
 288 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
 289
 290 /**
 291  *  Enable/disable joystick event polling.
 292  *
 293  *  If joystick events are disabled, you must call SDL_JoystickUpdate()
 294  *  yourself and check the state of the joystick when you want joystick
 295  *  information.
 296  *
 297  *  The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
 298  */
 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 /**
 304  *  Get the current state of an axis control on a joystick.
 305  *
 306  *  The state is a value ranging from -32768 to 32767.
 307  *
 308  *  The axis indices start at index 0.
 309  */
 310 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
 311                                                    int axis);
 312
 313 /**
 314  *  Get the initial state of an axis control on a joystick.
 315  *
 316  *  The state is a value ranging from -32768 to 32767.
 317  *
 318  *  The axis indices start at index 0.
 319  *
 320  *  \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
 321  */
 322 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
 323                                                    int axis, Sint16 *state);
 324
 325 /**
 326  *  \name Hat positions
 327  */
 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
 340 /**
 341  *  Get the current state of a POV hat on a joystick.
 342  *
 343  *  The hat indices start at index 0.
 344  *
 345  *  \return The return value is one of the following positions:
 346  *           - ::SDL_HAT_CENTERED
 347  *           - ::SDL_HAT_UP
 348  *           - ::SDL_HAT_RIGHT
 349  *           - ::SDL_HAT_DOWN
 350  *           - ::SDL_HAT_LEFT
 351  *           - ::SDL_HAT_RIGHTUP
 352  *           - ::SDL_HAT_RIGHTDOWN
 353  *           - ::SDL_HAT_LEFTUP
 354  *           - ::SDL_HAT_LEFTDOWN
 355  */
 356 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
 357                                                  int hat);
 358
 359 /**
 360  *  Get the ball axis change since the last poll.
 361  *
 362  *  \return 0, or -1 if you passed it invalid parameters.
 363  *
 364  *  The ball indices start at index 0.
 365  */
 366 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
 367                                                 int ball, int *dx, int *dy);
 368
 369 /**
 370  *  Get the current state of a button on a joystick.
 371  *
 372  *  The button indices start at index 0.
 373  */
 374 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
 375                                                     int button);
 376
 377 /**
 378  *  Trigger a rumble effect
 379  *  Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.
 380  *
 381  *  \param joystick The joystick to vibrate
 382  *  \param low_frequency_rumble The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
 383  *  \param high_frequency_rumble The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
 384  *  \param duration_ms The duration of the rumble effect, in milliseconds
 385  *
 386  *  \return 0, or -1 if rumble isn't supported on this joystick
 387  */
 388 extern DECLSPEC int SDLCALL SDL_JoystickRumble(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
 389
 390 /**
 391  *  Close a joystick previously opened with SDL_JoystickOpen().
 392  */
 393 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
 394
 395 /**
 396  *  Return the battery level of this joystick
 397  */
 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: */