include/SDL_joystick.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 31 Jan 2017 12:23:29 -0800
changeset 10868 a06c32b64184
parent 10865 179bcbe6c911
child 10870 b158d18e06d0
permissions -rw-r--r--
Added support for the HOTAS Warthog throttle
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2017 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 typedef Sint32 SDL_JoystickID;
    75 
    76 typedef enum
    77 {
    78     SDL_JOYSTICK_TYPE_UNKNOWN,
    79     SDL_JOYSTICK_TYPE_GAMECONTROLLER,
    80     SDL_JOYSTICK_TYPE_WHEEL,
    81     SDL_JOYSTICK_TYPE_ARCADE_STICK,
    82     SDL_JOYSTICK_TYPE_FLIGHT_STICK,
    83     SDL_JOYSTICK_TYPE_DANCE_PAD,
    84     SDL_JOYSTICK_TYPE_GUITAR,
    85     SDL_JOYSTICK_TYPE_DRUM_KIT,
    86     SDL_JOYSTICK_TYPE_ARCADE_PAD,
    87 	SDL_JOYSTICK_TYPE_THROTTLE,
    88 } SDL_JoystickType;
    89 
    90 typedef enum
    91 {
    92     SDL_JOYSTICK_POWER_UNKNOWN = -1,
    93     SDL_JOYSTICK_POWER_EMPTY,
    94     SDL_JOYSTICK_POWER_LOW,
    95     SDL_JOYSTICK_POWER_MEDIUM,
    96     SDL_JOYSTICK_POWER_FULL,
    97     SDL_JOYSTICK_POWER_WIRED,
    98     SDL_JOYSTICK_POWER_MAX
    99 } SDL_JoystickPowerLevel;
   100 
   101 /* Function prototypes */
   102 /**
   103  *  Count the number of joysticks attached to the system right now
   104  */
   105 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
   106 
   107 /**
   108  *  Get the implementation dependent name of a joystick.
   109  *  This can be called before any joysticks are opened.
   110  *  If no name can be found, this function returns NULL.
   111  */
   112 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
   113 
   114 /**
   115  *  Return the GUID for the joystick at this index
   116  *  This can be called before any joysticks are opened.
   117  */
   118 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
   119 
   120 /**
   121  *  Get the USB vendor ID of a joystick, if available.
   122  *  This can be called before any joysticks are opened.
   123  *  If the vendor ID isn't available this function returns 0.
   124  */
   125 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
   126 
   127 /**
   128  *  Get the USB product ID of a joystick, if available.
   129  *  This can be called before any joysticks are opened.
   130  *  If the product ID isn't available this function returns 0.
   131  */
   132 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
   133 
   134 /**
   135  *  Get the product version of a joystick, if available.
   136  *  This can be called before any joysticks are opened.
   137  *  If the product version isn't available this function returns 0.
   138  */
   139 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
   140 
   141 /**
   142  *  Get the type of a joystick, if available.
   143  *  This can be called before any joysticks are opened.
   144  */
   145 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
   146 
   147 /**
   148  *  Open a joystick for use.
   149  *  The index passed as an argument refers to the N'th joystick on the system.
   150  *  This index is not the value which will identify this joystick in future
   151  *  joystick events.  The joystick's instance id (::SDL_JoystickID) will be used
   152  *  there instead.
   153  *
   154  *  \return A joystick identifier, or NULL if an error occurred.
   155  */
   156 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
   157 
   158 /**
   159  * Return the SDL_Joystick associated with an instance id.
   160  */
   161 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
   162 
   163 /**
   164  *  Return the name for this currently opened joystick.
   165  *  If no name can be found, this function returns NULL.
   166  */
   167 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
   168 
   169 /**
   170  *  Return the GUID for this opened joystick
   171  */
   172 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
   173 
   174 /**
   175  *  Get the USB vendor ID of an opened joystick, if available.
   176  *  If the vendor ID isn't available this function returns 0.
   177  */
   178 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
   179 
   180 /**
   181  *  Get the USB product ID of an opened joystick, if available.
   182  *  If the product ID isn't available this function returns 0.
   183  */
   184 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
   185 
   186 /**
   187  *  Get the product version of an opened joystick, if available.
   188  *  If the product version isn't available this function returns 0.
   189  */
   190 extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
   191 
   192 /**
   193  *  Get the type of an opened joystick.
   194  */
   195 extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
   196 
   197 /**
   198  *  Return a string representation for this guid. pszGUID must point to at least 33 bytes
   199  *  (32 for the string plus a NULL terminator).
   200  */
   201 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
   202 
   203 /**
   204  *  Convert a string into a joystick guid
   205  */
   206 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
   207 
   208 /**
   209  *  Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
   210  */
   211 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
   212 
   213 /**
   214  *  Get the instance ID of an opened joystick or -1 if the joystick is invalid.
   215  */
   216 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
   217 
   218 /**
   219  *  Get the number of general axis controls on a joystick.
   220  */
   221 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
   222 
   223 /**
   224  *  Get the number of trackballs on a joystick.
   225  *
   226  *  Joystick trackballs have only relative motion events associated
   227  *  with them and their state cannot be polled.
   228  */
   229 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
   230 
   231 /**
   232  *  Get the number of POV hats on a joystick.
   233  */
   234 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
   235 
   236 /**
   237  *  Get the number of buttons on a joystick.
   238  */
   239 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
   240 
   241 /**
   242  *  Update the current state of the open joysticks.
   243  *
   244  *  This is called automatically by the event loop if any joystick
   245  *  events are enabled.
   246  */
   247 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
   248 
   249 /**
   250  *  Enable/disable joystick event polling.
   251  *
   252  *  If joystick events are disabled, you must call SDL_JoystickUpdate()
   253  *  yourself and check the state of the joystick when you want joystick
   254  *  information.
   255  *
   256  *  The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
   257  */
   258 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
   259 
   260 #define SDL_JOYSTICK_AXIS_MAX   32767
   261 #define SDL_JOYSTICK_AXIS_MIN   -32768
   262 /**
   263  *  Get the current state of an axis control on a joystick.
   264  *
   265  *  The state is a value ranging from -32768 to 32767.
   266  *
   267  *  The axis indices start at index 0.
   268  */
   269 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
   270                                                    int axis);
   271 
   272 /**
   273  *  Get the initial state of an axis control on a joystick.
   274  *
   275  *  The state is a value ranging from -32768 to 32767.
   276  *
   277  *  The axis indices start at index 0.
   278  *
   279  *  \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
   280  */
   281 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
   282                                                    int axis, Sint16 *state);
   283 
   284 /**
   285  *  \name Hat positions
   286  */
   287 /* @{ */
   288 #define SDL_HAT_CENTERED    0x00
   289 #define SDL_HAT_UP          0x01
   290 #define SDL_HAT_RIGHT       0x02
   291 #define SDL_HAT_DOWN        0x04
   292 #define SDL_HAT_LEFT        0x08
   293 #define SDL_HAT_RIGHTUP     (SDL_HAT_RIGHT|SDL_HAT_UP)
   294 #define SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)
   295 #define SDL_HAT_LEFTUP      (SDL_HAT_LEFT|SDL_HAT_UP)
   296 #define SDL_HAT_LEFTDOWN    (SDL_HAT_LEFT|SDL_HAT_DOWN)
   297 /* @} */
   298 
   299 /**
   300  *  Get the current state of a POV hat on a joystick.
   301  *
   302  *  The hat indices start at index 0.
   303  *
   304  *  \return The return value is one of the following positions:
   305  *           - ::SDL_HAT_CENTERED
   306  *           - ::SDL_HAT_UP
   307  *           - ::SDL_HAT_RIGHT
   308  *           - ::SDL_HAT_DOWN
   309  *           - ::SDL_HAT_LEFT
   310  *           - ::SDL_HAT_RIGHTUP
   311  *           - ::SDL_HAT_RIGHTDOWN
   312  *           - ::SDL_HAT_LEFTUP
   313  *           - ::SDL_HAT_LEFTDOWN
   314  */
   315 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
   316                                                  int hat);
   317 
   318 /**
   319  *  Get the ball axis change since the last poll.
   320  *
   321  *  \return 0, or -1 if you passed it invalid parameters.
   322  *
   323  *  The ball indices start at index 0.
   324  */
   325 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
   326                                                 int ball, int *dx, int *dy);
   327 
   328 /**
   329  *  Get the current state of a button on a joystick.
   330  *
   331  *  The button indices start at index 0.
   332  */
   333 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
   334                                                     int button);
   335 
   336 /**
   337  *  Close a joystick previously opened with SDL_JoystickOpen().
   338  */
   339 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
   340 
   341 /**
   342  *  Return the battery level of this joystick
   343  */
   344 extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick);
   345 
   346 /* Ends C function definitions when using C++ */
   347 #ifdef __cplusplus
   348 }
   349 #endif
   350 #include "close_code.h"
   351 
   352 #endif /* SDL_joystick_h_ */
   353 
   354 /* vi: set ts=4 sw=4 expandtab: */