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