src/joystick/SDL_sysjoystick.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2018 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 #include "../SDL_internal.h"
  22
  23 #ifndef SDL_sysjoystick_h_
  24 #define SDL_sysjoystick_h_
  25
  26 /* This is the system specific header for the SDL joystick API */
  27
  28 #include "SDL_joystick.h"
  29 #include "SDL_joystick_c.h"
  30
  31 /* The SDL joystick structure */
  32 typedef struct _SDL_JoystickAxisInfo
  33 {
  34     Sint16 initial_value;       /* Initial axis state */
  35     Sint16 value;               /* Current axis state */
  36     Sint16 zero;                /* Zero point on the axis (-32768 for triggers) */
  37     SDL_bool has_initial_value; /* Whether we've seen a value on the axis yet */
  38     SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
  39 } SDL_JoystickAxisInfo;
  40
  41 struct _SDL_Joystick
  42 {
  43     SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
  44     char *name;                 /* Joystick name - system dependent */
  45
  46     int naxes;                  /* Number of axis controls on the joystick */
  47     SDL_JoystickAxisInfo *axes;
  48
  49     int nhats;                  /* Number of hats on the joystick */
  50     Uint8 *hats;                /* Current hat states */
  51
  52     int nballs;                 /* Number of trackballs on the joystick */
  53     struct balldelta {
  54         int dx;
  55         int dy;
  56     } *balls;                   /* Current ball motion deltas */
  57
  58     int nbuttons;               /* Number of buttons on the joystick */
  59     Uint8 *buttons;             /* Current button states */
  60
  61     struct joystick_hwdata *hwdata;     /* Driver dependent information */
  62
  63     int ref_count;              /* Reference count for multiple opens */
  64
  65     SDL_bool is_game_controller;
  66     SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
  67     SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
  68     struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
  69 };
  70
  71 /* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
  72 #define MAKE_VIDPID(VID, PID)   (((Uint32)(VID))<<16|(PID))
  73
  74 /* Function to scan the system for joysticks.
  75  * Joystick 0 should be the system default joystick.
  76  * This function should return the number of available joysticks, or -1
  77  * on an unrecoverable fatal error.
  78  */
  79 extern int SDL_SYS_JoystickInit(void);
  80
  81 /* Function to return the number of joystick devices plugged in right now */
  82 extern int SDL_SYS_NumJoysticks(void);
  83
  84 /* Function to cause any queued joystick insertions to be processed */
  85 extern void SDL_SYS_JoystickDetect(void);
  86
  87 /* Function to get the device-dependent name of a joystick */
  88 extern const char *SDL_SYS_JoystickNameForDeviceIndex(int device_index);
  89
  90 /* Function to get the current instance id of the joystick located at device_index */
  91 extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
  92
  93 /* Function to open a joystick for use.
  94    The joystick to open is specified by the device index.
  95    This should fill the nbuttons and naxes fields of the joystick structure.
  96    It returns 0, or -1 if there is an error.
  97  */
  98 extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
  99
 100 /* Function to query if the joystick is currently attached
 101  * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
 102  */
 103 extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
 104
 105 /* Function to update the state of a joystick - called as a device poll.
 106  * This function shouldn't update the joystick structure directly,
 107  * but instead should call SDL_PrivateJoystick*() to deliver events
 108  * and update joystick device state.
 109  */
 110 extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
 111
 112 /* Function to close a joystick after use */
 113 extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
 114
 115 /* Function to perform any system-specific joystick related cleanup */
 116 extern void SDL_SYS_JoystickQuit(void);
 117
 118 /* Function to return the stable GUID for a plugged in device */
 119 extern SDL_JoystickGUID SDL_SYS_JoystickGetDeviceGUID(int device_index);
 120
 121 /* Function to return the stable GUID for a opened joystick */
 122 extern SDL_JoystickGUID SDL_SYS_JoystickGetGUID(SDL_Joystick * joystick);
 123
 124 #if SDL_JOYSTICK_XINPUT
 125 /* Function returns SDL_TRUE if this device is an XInput gamepad */
 126 extern SDL_bool SDL_SYS_IsXInputGamepad_DeviceIndex(int device_index);
 127 #endif
 128
 129 #if defined(__ANDROID__)
 130 /* Function returns SDL_TRUE if this device is a DPAD (maybe a TV remote) */
 131 extern SDL_bool SDL_SYS_IsDPAD_DeviceIndex(int device_index);
 132 #endif
 133
 134 #endif /* SDL_sysjoystick_h_ */
 135
 136 /* vi: set ts=4 sw=4 expandtab: */