Add new SwitchProControlleriOS device for iOS, which has swapped face buttons

Also includes new state, for any devices which use the Nintendo-y button bindings

Author: vallerieknight-unity

Packages/com.unity.inputsystem/InputSystem/Plugins/iOS/IOSGameController.cs

@@ -1,5 +1,6 @@
 #if UNITY_EDITOR || UNITY_IOS || UNITY_TVOS || UNITY_VISIONOS || PACKAGE_DOCS_GENERATION
 using System.Runtime.InteropServices;
+using UnityEngine.InputSystem.Controls;
 using UnityEngine.InputSystem.DualShock;
 using UnityEngine.InputSystem.Layouts;
 using UnityEngine.InputSystem.LowLevel;
@@ -95,6 +96,66 @@ public iOSGameControllerState WithAxis(iOSAxis axis, float value)
             return this;
         }
     }
+
+    /// <summary>
+    /// State for iOS Gamepads using a layout where B button is south, A is east, X is north, and Y is west
+    /// This layout is typically seen on Nintendo gamepads, such as the Switch Pro Controller.
+    /// </summary>
+    [StructLayout(LayoutKind.Sequential)]
+    internal unsafe struct iOSGameControllerStateSwappedFaceButtons : IInputStateTypeInfo
+    {
+        public static FourCC kFormat = new FourCC('I', 'G', 'C', ' ');
+        public const int MaxButtons = (int)iOSButton.Select + 1;
+        public const int MaxAxis = (int)iOSAxis.RightStickY + 1;
+
+        [InputControl(name = "dpad")]
+        [InputControl(name = "dpad/up", bit = (uint)iOSButton.DpadUp)]
+        [InputControl(name = "dpad/right", bit = (uint)iOSButton.DpadRight)]
+        [InputControl(name = "dpad/down", bit = (uint)iOSButton.DpadDown)]
+        [InputControl(name = "dpad/left", bit = (uint)iOSButton.DpadLeft)]
+        [InputControl(name = "buttonSouth", bit = (uint)iOSButton.B)]
+        [InputControl(name = "buttonWest", bit = (uint)iOSButton.Y)]
+        [InputControl(name = "buttonNorth", bit = (uint)iOSButton.X)]
+        [InputControl(name = "buttonEast", bit = (uint)iOSButton.A)]
+        [InputControl(name = "leftStickPress", bit = (uint)iOSButton.LeftStick)]
+        [InputControl(name = "rightStickPress", bit = (uint)iOSButton.RightStick)]
+        [InputControl(name = "leftShoulder", bit = (uint)iOSButton.LeftShoulder)]
+        [InputControl(name = "rightShoulder", bit = (uint)iOSButton.RightShoulder)]
+        [InputControl(name = "start", bit = (uint)iOSButton.Start)]
+        [InputControl(name = "select", bit = (uint)iOSButton.Select)]
+        public uint buttons;
+
+        [InputControl(name = "leftTrigger", offset = sizeof(uint) + sizeof(float) * (uint)iOSButton.LeftTrigger)]
+        [InputControl(name = "rightTrigger", offset = sizeof(uint) + sizeof(float) * (uint)iOSButton.RightTrigger)]
+        public fixed float buttonValues[MaxButtons];
+
+        private const uint kAxisOffset = sizeof(uint) + sizeof(float) * MaxButtons;
+        [InputControl(name = "leftStick", offset = (uint)iOSAxis.LeftStickX * sizeof(float) + kAxisOffset)]
+        [InputControl(name = "rightStick", offset = (uint)iOSAxis.RightStickX * sizeof(float) + kAxisOffset)]
+        public fixed float axisValues[MaxAxis];
+
+        public FourCC format => kFormat;
+
+        public iOSGameControllerStateSwappedFaceButtons WithButton(iOSButton button, bool value = true, float rawValue = 1.0f)
+        {
+            buttonValues[(int)button] = rawValue;
+
+            Debug.Assert((int)button < 32, $"Expected button < 32, so we fit into the 32 bit wide bitmask");
+            var bit = 1U << (int)button;
+            if (value)
+                buttons |= bit;
+            else
+                buttons &= ~bit;
+
+            return this;
+        }
+
+        public iOSGameControllerStateSwappedFaceButtons WithAxis(iOSAxis axis, float value)
+        {
+            axisValues[(int)axis] = value;
+            return this;
+        }
+    }
 }
 
 namespace UnityEngine.InputSystem.iOS
@@ -134,5 +195,41 @@ public class DualShock4GampadiOS : DualShockGamepad
     public class DualSenseGampadiOS : DualShockGamepad
     {
     }
+
+    /// <summary>
+    /// A Switch Pro Controller connected to an iOS device.
+    /// If you use InputSystem.GetDevice, you must query for this class rather than Gamepad in order for aButton, bButton, yButton and xButton to be correct
+    /// </summary>
+    [InputControlLayout(stateType = typeof(iOSGameControllerStateSwappedFaceButtons), displayName = "iOS Switch Pro Controller Gamepad")]
+    public class SwitchProControlleriOS : Gamepad
+    {
+        /// <summary>
+        /// A Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonSouth, whereas this class returns the state of buttonEast
+        /// </summary>
+        public new ButtonControl aButton => buttonEast;
+
+        /// <summary>
+        /// A Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonEast, whereas this class returns the state of buttonSouth
+        /// </summary>
+        public new ButtonControl bButton => buttonSouth;
+
+        /// <summary>
+        /// A Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonNorth, whereas this class returns the state of buttonWest
+        /// </summary>
+        public new ButtonControl yButton => buttonWest;
+
+        /// <summary>
+        /// A Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonWest, whereas this class returns the state of buttonNorth
+        /// </summary>
+        public new ButtonControl xButton => buttonNorth;
+    }
 }
 #endif // UNITY_EDITOR || UNITY_IOS || UNITY_TVOS || UNITY_VISIONOS

Packages/com.unity.inputsystem/InputSystem/Plugins/iOS/iOSSupport.cs

@@ -37,6 +37,12 @@ public static void Initialize()
                     .WithDeviceClass("iOSGameController")
                     .WithProduct("DualSense Wireless Controller"));
 
+            InputSystem.RegisterLayout<SwitchProControlleriOS>("SwitchProGamepadiOS",
+                matches: new InputDeviceMatcher()
+                    .WithInterface("iOS")
+                    .WithDeviceClass("iOSGameController")
+                    .WithProduct("Pro Controller"));
+
             InputSystem.RegisterLayoutMatcher("GravitySensor",
                 new InputDeviceMatcher()
                     .WithInterface("iOS")