1 /* 2 Simple DirectMedia Layer 3 Copyright (C) 1997-2021 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 #ifndef SDL_joystick_c_h_ 23 #define SDL_joystick_c_h_ 24 25 #include "../SDL_internal.h" 26 27 /* Useful functions and variables from SDL_joystick.c */ 28 #include "SDL_gamecontroller.h" 29 #include "SDL_joystick.h" 30 31 struct _SDL_JoystickDriver; 32 33 /* Initialization and shutdown functions */ 34 extern int SDL_JoystickInit(void); 35 extern void SDL_JoystickQuit(void); 36 37 /* Function to get the next available joystick instance ID */ 38 extern SDL_JoystickID SDL_GetNextJoystickInstanceID(void); 39 40 /* Initialization and shutdown functions */ 41 extern int SDL_GameControllerInitMappings(void); 42 extern void SDL_GameControllerQuitMappings(void); 43 extern int SDL_GameControllerInit(void); 44 extern void SDL_GameControllerQuit(void); 45 46 /* Function to get the joystick driver and device index for an API device index */ 47 extern SDL_bool SDL_GetDriverAndJoystickIndex(int device_index, struct _SDL_JoystickDriver **driver, int *driver_index); 48 49 /* Function to return the device index for a joystick ID, or -1 if not found */ 50 extern int SDL_JoystickGetDeviceIndexFromInstanceID(SDL_JoystickID instance_id); 51 52 /* Function to extract information from an SDL joystick GUID */ 53 extern void SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint16 *vendor, Uint16 *product, Uint16 *version); 54 55 /* Function to standardize the name for a controller 56 This should be freed with SDL_free() when no longer needed 57 */ 58 extern char *SDL_CreateJoystickName(Uint16 vendor, Uint16 product, const char *vendor_name, const char *product_name); 59 60 /* Function to return the type of a controller */ 61 extern SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromVIDPID(Uint16 vendor, Uint16 product); 62 extern SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGUID guid, const char *name); 63 extern SDL_GameControllerType SDL_GetJoystickGameControllerType(const char *name, Uint16 vendor, Uint16 product, int interface_number, int interface_class, int interface_subclass, int interface_protocol); 64 65 /* Function to return whether a joystick is an Xbox One Elite controller */ 66 extern SDL_bool SDL_IsJoystickXboxOneElite(Uint16 vendor_id, Uint16 product_id); 67 68 /* Function to return whether a joystick is an Xbox Series X controller */ 69 extern SDL_bool SDL_IsJoystickXboxSeriesX(Uint16 vendor_id, Uint16 product_id); 70 71 /* Function to return whether a joystick is an Xbox One controller connected via Bluetooth */ 72 extern SDL_bool SDL_IsJoystickBluetoothXboxOne(Uint16 vendor_id, Uint16 product_id); 73 74 /* Function to return whether a joystick is a PS4 controller */ 75 extern SDL_bool SDL_IsJoystickPS4(Uint16 vendor_id, Uint16 product_id); 76 77 /* Function to return whether a joystick is a PS5 controller */ 78 extern SDL_bool SDL_IsJoystickPS5(Uint16 vendor_id, Uint16 product_id); 79 80 /* Function to return whether a joystick is a Nintendo Switch Pro controller */ 81 extern SDL_bool SDL_IsJoystickNintendoSwitchPro(Uint16 vendor_id, Uint16 product_id); 82 extern SDL_bool SDL_IsJoystickNintendoSwitchProInputOnly(Uint16 vendor_id, Uint16 product_id); 83 extern SDL_bool SDL_IsJoystickNintendoSwitchJoyCon(Uint16 vendor_id, Uint16 product_id); 84 extern SDL_bool SDL_IsJoystickNintendoSwitchJoyConLeft(Uint16 vendor_id, Uint16 product_id); 85 extern SDL_bool SDL_IsJoystickNintendoSwitchJoyConRight(Uint16 vendor_id, Uint16 product_id); 86 87 /* Function to return whether a joystick is a Steam Controller */ 88 extern SDL_bool SDL_IsJoystickSteamController(Uint16 vendor_id, Uint16 product_id); 89 90 /* Function to return whether a joystick guid comes from the XInput driver */ 91 extern SDL_bool SDL_IsJoystickXInput(SDL_JoystickGUID guid); 92 93 /* Function to return whether a joystick guid comes from the WGI driver */ 94 extern SDL_bool SDL_IsJoystickWGI(SDL_JoystickGUID guid); 95 96 /* Function to return whether a joystick guid comes from the HIDAPI driver */ 97 extern SDL_bool SDL_IsJoystickHIDAPI(SDL_JoystickGUID guid); 98 99 /* Function to return whether a joystick guid comes from the RAWINPUT driver */ 100 extern SDL_bool SDL_IsJoystickRAWINPUT(SDL_JoystickGUID guid); 101 102 /* Function to return whether a joystick guid comes from the Virtual driver */ 103 extern SDL_bool SDL_IsJoystickVirtual(SDL_JoystickGUID guid); 104 105 /* Function to return whether a joystick should be ignored */ 106 extern SDL_bool SDL_ShouldIgnoreJoystick(const char *name, SDL_JoystickGUID guid); 107 108 /* Function to return whether a joystick name and GUID is a game controller */ 109 extern SDL_bool SDL_IsGameControllerNameAndGUID(const char *name, SDL_JoystickGUID guid); 110 111 /* Function to return whether a game controller should be ignored */ 112 extern SDL_bool SDL_ShouldIgnoreGameController(const char *name, SDL_JoystickGUID guid); 113 114 /* Handle delayed guide button on a game controller */ 115 extern void SDL_GameControllerHandleDelayedGuideButton(SDL_Joystick *joystick); 116 117 /* Internal event queueing functions */ 118 extern void SDL_PrivateJoystickAddTouchpad(SDL_Joystick *joystick, int nfingers); 119 extern void SDL_PrivateJoystickAddSensor(SDL_Joystick *joystick, SDL_SensorType type, float rate); 120 extern void SDL_PrivateJoystickAdded(SDL_JoystickID device_instance); 121 extern void SDL_PrivateJoystickRemoved(SDL_JoystickID device_instance); 122 extern int SDL_PrivateJoystickAxis(SDL_Joystick *joystick, 123 Uint8 axis, Sint16 value); 124 extern int SDL_PrivateJoystickBall(SDL_Joystick *joystick, 125 Uint8 ball, Sint16 xrel, Sint16 yrel); 126 extern int SDL_PrivateJoystickHat(SDL_Joystick *joystick, 127 Uint8 hat, Uint8 value); 128 extern int SDL_PrivateJoystickButton(SDL_Joystick *joystick, 129 Uint8 button, Uint8 state); 130 extern int SDL_PrivateJoystickTouchpad(SDL_Joystick *joystick, 131 int touchpad, int finger, Uint8 state, float x, float y, float pressure); 132 extern int SDL_PrivateJoystickSensor(SDL_Joystick *joystick, 133 SDL_SensorType type, const float *data, int num_values); 134 extern void SDL_PrivateJoystickBatteryLevel(SDL_Joystick *joystick, 135 SDL_JoystickPowerLevel ePowerLevel); 136 137 /* Internal sanity checking functions */ 138 extern SDL_bool SDL_PrivateJoystickValid(SDL_Joystick *joystick); 139 140 typedef enum 141 { 142 EMappingKind_None = 0, 143 EMappingKind_Button = 1, 144 EMappingKind_Axis = 2, 145 EMappingKind_Hat = 3 146 } EMappingKind; 147 148 typedef struct _SDL_InputMapping 149 { 150 EMappingKind kind; 151 Uint8 target; 152 } SDL_InputMapping; 153 154 typedef struct _SDL_GamepadMapping 155 { 156 SDL_InputMapping a; 157 SDL_InputMapping b; 158 SDL_InputMapping x; 159 SDL_InputMapping y; 160 SDL_InputMapping back; 161 SDL_InputMapping guide; 162 SDL_InputMapping start; 163 SDL_InputMapping leftstick; 164 SDL_InputMapping rightstick; 165 SDL_InputMapping leftshoulder; 166 SDL_InputMapping rightshoulder; 167 SDL_InputMapping dpup; 168 SDL_InputMapping dpdown; 169 SDL_InputMapping dpleft; 170 SDL_InputMapping dpright; 171 SDL_InputMapping leftx; 172 SDL_InputMapping lefty; 173 SDL_InputMapping rightx; 174 SDL_InputMapping righty; 175 SDL_InputMapping lefttrigger; 176 SDL_InputMapping righttrigger; 177 } SDL_GamepadMapping; 178 179 /* Function to get autodetected gamepad controller mapping from the driver */ 180 extern SDL_bool SDL_PrivateJoystickGetAutoGamepadMapping(int device_index, 181 SDL_GamepadMapping *out); 182 183 #endif /* SDL_joystick_c_h_ */ 184 185 /* vi: set ts=4 sw=4 expandtab: */ 186