Support returning sfSymbolsName for gamepad controls on macOS / iOS / tvOS
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
diff --git a/include/SDL_gamecontroller.h b/include/SDL_gamecontroller.h
index 695201e..9ca41bd 100644
--- a/include/SDL_gamecontroller.h
+++ b/include/SDL_gamecontroller.h
@@ -931,6 +931,26 @@ extern DECLSPEC int SDLCALL SDL_GameControllerSendEffect(SDL_GameController *gam
*/
extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecontroller);
+/**
+ * Return the sfSymbolsName for a given button on a game controller on Apple platforms.
+ *
+ * \param gamecontroller the controller to query
+ * \param button a button on the game controller
+ *
+ */
+extern DECLSPEC const char* SDLCALL SDL_GameControllerGetAppleSFSymbolsNameForButton(SDL_GameController *gamecontroller, SDL_GameControllerButton button);
+
+/**
+ * Return the sfSymbolsName for a given axis on a game controller on Apple platforms.
+ *
+ * \param gamecontroller the controller to query
+ * \param button an axis on the game controller
+ *
+ */
+extern DECLSPEC const char* SDLCALL SDL_GameControllerGetAppleSFSymbolsNameForAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis);
+
+
+
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
diff --git a/src/joystick/iphoneos/SDL_mfijoystick.m b/src/joystick/iphoneos/SDL_mfijoystick.m
index d0d1bf5..0bfa692 100644
--- a/src/joystick/iphoneos/SDL_mfijoystick.m
+++ b/src/joystick/iphoneos/SDL_mfijoystick.m
@@ -1548,6 +1548,263 @@ SDL_bool IOS_SupportedHIDDevice(IOHIDDeviceRef device)
}
#endif
+#if defined(SDL_JOYSTICK_MFI) && defined(ENABLE_PHYSICAL_INPUT_PROFILE)
+static void
+GetAppleSFSymbolsNameForElement(GCControllerElement *element, char *name)
+{
+ if (@available(macos 11.0, iOS 14.0, tvOS 14.0, *)) {
+ if (element) {
+ [element.sfSymbolsName getCString: name maxLength: 255 encoding: NSASCIIStringEncoding];
+ }
+ }
+}
+
+static GCControllerDirectionPad *
+GetDirectionalPadForController(GCController *controller)
+{
+ if (controller.extendedGamepad) {
+ return controller.extendedGamepad.dpad;
+ }
+
+ if (controller.gamepad) {
+ return controller.gamepad.dpad;
+ }
+
+ if (controller.microGamepad) {
+ return controller.microGamepad.dpad;
+ }
+
+ return nil;
+}
+#endif
+
+
+static char elementName[256];
+
+const char *
+SDL_GameControllerGetAppleSFSymbolsNameForButton(SDL_GameController *gamecontroller, SDL_GameControllerButton button)
+{
+ elementName[0] = '\0';
+ if (!gamecontroller) {
+ return elementName;
+ }
+ if (SDL_GameControllerGetJoystick(gamecontroller)->driver != &SDL_IOS_JoystickDriver) {
+ return elementName;
+ }
+#if defined(SDL_JOYSTICK_MFI) && defined(ENABLE_PHYSICAL_INPUT_PROFILE)
+ if (@available(iOS 14.0, tvOS 14.0, macOS 11.0, *)) {
+ GCController *controller = SDL_GameControllerGetJoystick(gamecontroller)->hwdata->controller;
+ if ([controller respondsToSelector:@selector(physicalInputProfile)]) {
+ NSDictionary<NSString *,GCControllerElement *> *elements = controller.physicalInputProfile.elements;
+ switch (button)
+ {
+ case SDL_CONTROLLER_BUTTON_INVALID: {
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_A: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonA], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_B: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonB], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_X: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonX], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_Y: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonY], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_BACK: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonOptions], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_GUIDE: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonHome], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_START: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputButtonMenu], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_LEFTSTICK: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputLeftThumbstickButton], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_RIGHTSTICK: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputRightThumbstickButton], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_LEFTSHOULDER: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputLeftShoulder], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_RIGHTSHOULDER: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputRightShoulder], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_DPAD_UP: {
+ GCControllerDirectionPad * dpad = GetDirectionalPadForController(controller);
+ if (dpad) {
+ GetAppleSFSymbolsNameForElement(dpad.up, elementName);
+ if (SDL_strlen(elementName) == 0) {
+ SDL_strlcpy( elementName, "dpad.up.fill", 255 );
+ }
+ }
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_DPAD_DOWN: {
+ GCControllerDirectionPad * dpad = GetDirectionalPadForController(controller);
+ if (dpad) {
+ GetAppleSFSymbolsNameForElement(dpad.down, elementName);
+ if (SDL_strlen(elementName) == 0) {
+ SDL_strlcpy( elementName, "dpad.down.fill", 255 );
+ }
+ }
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_DPAD_LEFT: {
+ GCControllerDirectionPad * dpad = GetDirectionalPadForController(controller);
+ if (dpad) {
+ GetAppleSFSymbolsNameForElement(dpad.left, elementName);
+ if (SDL_strlen(elementName) == 0) {
+ SDL_strlcpy( elementName, "dpad.left.fill", 255 );
+ }
+ }
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_DPAD_RIGHT: {
+ GCControllerDirectionPad * dpad = GetDirectionalPadForController(controller);
+ if (dpad) {
+ GetAppleSFSymbolsNameForElement(dpad.right, elementName);
+ if (SDL_strlen(elementName) == 0) {
+ SDL_strlcpy( elementName, "dpad.right.fill", 255 );
+ }
+ }
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_MISC1: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputDualShockTouchpadButton], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_PADDLE1: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputXboxPaddleOne], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_PADDLE2: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputXboxPaddleTwo], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_PADDLE3: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputXboxPaddleThree], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_PADDLE4: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputXboxPaddleFour], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_TOUCHPAD: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputDualShockTouchpadButton], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_BUTTON_MAX: {
+ break;
+ }
+ }
+ }
+ }
+#endif
+ return elementName;
+}
+
+
+const char *
+SDL_GameControllerGetAppleSFSymbolsNameForAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
+{
+ elementName[0] = '\0';
+ if (!gamecontroller) {
+ return elementName;
+ }
+ if (SDL_GameControllerGetJoystick(gamecontroller)->driver != &SDL_IOS_JoystickDriver) {
+ return elementName;
+ }
+#if defined(SDL_JOYSTICK_MFI) && defined(ENABLE_PHYSICAL_INPUT_PROFILE)
+ if (@available(iOS 14.0, tvOS 14.0, macOS 11.0, *)) {
+ GCController *controller = SDL_GameControllerGetJoystick(gamecontroller)->hwdata->controller;
+ if ([controller respondsToSelector:@selector(physicalInputProfile)]) {
+ NSDictionary<NSString *,GCControllerElement *> *elements = controller.physicalInputProfile.elements;
+ switch (axis)
+ {
+
+ case SDL_CONTROLLER_AXIS_INVALID:
+ break;
+
+ case SDL_CONTROLLER_AXIS_LEFTX:{
+ GetAppleSFSymbolsNameForElement(elements[GCInputLeftThumbstick], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_LEFTY: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputLeftThumbstick], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_RIGHTX: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputRightThumbstick], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_RIGHTY: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputRightThumbstick], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_TRIGGERLEFT: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputLeftTrigger], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_TRIGGERRIGHT: {
+ GetAppleSFSymbolsNameForElement(elements[GCInputRightTrigger], elementName);
+ break;
+ }
+
+ case SDL_CONTROLLER_AXIS_MAX: {
+ break;
+ }
+ }
+ }
+ }
+#endif
+ return elementName;
+}
+
+
+
SDL_JoystickDriver SDL_IOS_JoystickDriver =
{
IOS_JoystickInit,