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