NEW: iOS gamepads support (#890)

Author: jechter

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -371,7 +371,6 @@ bool IgnoreTypeForDocs(TypeDefinition type)
             type.FullName == typeof(UnityEngine.InputSystem.Steam.SteamHandle<>).FullName ||
             type.FullName == typeof(UnityEngine.InputSystem.Steam.Editor.SteamIGAConverter).FullName ||
 #endif
-            type.FullName == typeof(UnityEngine.InputSystem.iOS.iOSGameController).FullName ||
             type.FullName == typeof(UnityEngine.InputSystem.DualShock.DualShock3GamepadHID).FullName ||
             type.FullName == typeof(UnityEngine.InputSystem.DualShock.DualShock4GamepadHID).FullName ||
             type.FullName == typeof(UnityEngine.InputSystem.Android.AndroidAccelerometer).FullName ||

ExternalSampleProjects/InputDeviceTester/Assets/InputDeviceTester/Scripts/Input/XboxISX.cs

@@ -14,16 +14,16 @@ void Start()
     {
         //m_stickMaxMove = 0.25f;
 
-        m_buttonAction = new InputAction(name: "XboxButtonAction", InputActionType.PassThrough, binding: "XInputController*/<button>");
+        m_buttonAction = new InputAction(name: "XboxButtonAction", InputActionType.PassThrough, binding: "<XInputController>/<button>");
         m_buttonAction.performed += callbackContext => OnControllerButtonPress(callbackContext.control as ButtonControl, isXbox: true);
         m_buttonAction.Enable();
 
-        m_dPadAction = new InputAction(name: "XboxDpadAction", InputActionType.PassThrough, binding: "XInputController*/<dpad>");
+        m_dPadAction = new InputAction(name: "XboxDpadAction", InputActionType.PassThrough, binding: "<XInputController>/<dpad>");
         m_dPadAction.performed += callbackContext => OnDpadPress(callbackContext.control as DpadControl);
         m_dPadAction.Enable();
 
         m_stickMoveAction = new InputAction(name: "XboxStickMoveAction", InputActionType.PassThrough,
-            binding: "XInputController*/<stick>");
+            binding: "<XInputController>/<stick>");
         m_stickMoveAction.performed += callbackContext => StickMove(callbackContext.control as StickControl);
         m_stickMoveAction.Enable();
     }

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -30,6 +30,7 @@ however, it has to be formatted properly to pass verification tests.
 
 ### Added
 
+- Will now recognize Xbox One and PS4 controllers connected to iOS devices correctly as Xbox One and PS4 controllers.
 - Added a new sample called "Custom Device Usages" that shows how to use a layout override on `Gamepad` to allow distinguishing two gamepads in bindings based on which player the gamepad is assigned to.
 
 ## [1.0.0-preview] - 2019-9-20

Packages/com.unity.inputsystem/Documentation~/Gamepad.md

@@ -101,6 +101,9 @@ PlayStation controllers are well supported on different Devices. The Input Syste
 
 * [`DualShock4GamepadHID`](../api/UnityEngine.InputSystem.DualShock.DualShock4GamepadHID.html): A DualShock 4 controller connected to a desktop computer using the HID interface. Supported on macOS, Windows, UWP, and Linux.
 
+*
+[`DualShock4GampadiOS`](../api/UnityEngine.InputSystem.iOS.DualShock4GampadiOS.html): A DualShock 4 controller connected to an iOS Device via Bluetooth. Requires iOS 13 or higher.
+
 [`DualShock4GamepadHID`](../api/UnityEngine.InputSystem.DualShock.DualShock4GamepadHID.html) implements additional, DualShock-specific functionality on top the general support in the [`Gamepad`](../api/UnityEngine.InputSystem.Gamepad.html) class:
 
 * [`SetLightBarColor(Color)`](../api/UnityEngine.InputSystem.DualShock.DualShockGamepad.html#UnityEngine_InputSystem_DualShock_DualShockGamepad_SetLightBarColor_Color_): Lets you set the color of the light bar on the controller.
@@ -119,6 +122,9 @@ On other platforms Unity uses derived classes to represent Xbox controllers:
 
 * [`XboxOneGampadMacOSWireless`](../api/UnityEngine.InputSystem.XInput.XboxOneGampadMacOSWireless.html): An Xbox One controller connected to a Mac via Bluetooth. Only the latest generation of Xbox One controllers supports Bluetooth. These controllers don't require any additional drivers in this scenario.
 
+*
+[`XboxOneGampadiOS`](../api/UnityEngine.InputSystem.iOS.XboxOneGampadiOS.html): An Xbox One controller connected to an iOS Device via Bluetooth. Requires iOS 13 or higher.
+
 >__Note__:
 >* XInput controllers on Mac currently require the installation of the [Xbox Controller Driver for macOS](https://github.com/360Controller/360Controller). Only USB connections are supported by this driver, no wireless dongles. However, the latest generation of Xbox One controllers natively supported Bluetooth. Macs natively support these controllers as HIDs without any additional drivers when connected via Bluetooth.
 >* Unity supports Xbox controllers on WebGL in some browser and OS configurations, but treats them as basic [`Gamepad`](../api/UnityEngine.InputSystem.Gamepad.html) or [`Joystick`](../api/UnityEngine.InputSystem.Joystick.html) Devices, and doesn't support Rumble or any other Xbox-specific functionality.

Packages/com.unity.inputsystem/Documentation~/SupportedDevices.md

@@ -25,8 +25,8 @@ The following Devices are supported in a way that doesn't require specialized su
 |Device|Windows|Mac|Linux|UWP|Android|iOS(6)|Xbox(7)|PS4(7)|Switch(7)|WebGL|
 |------|-------|---|-----|---|-------|---|----|---|------|-----|
 |Xbox 360 (4)|Yes|Yes (3)|Yes|Yes|No|No|Yes|No|No|Sometimes (2)|
-|Xbox One|Yes (1)|Yes (3)|Yes (1)|Yes|Yes (1)|No|Yes|No|No|Sometimes (2)|
-|PS4|Yes (5)|Yes (5)|Yes (5)|Yes (5)|Yes (5)|No|No|Yes|No|Sometimes (2)|
+|Xbox One|Yes (1)|Yes (3)|Yes (1)|Yes|Yes (1)|Yes (6)|Yes|No|No|Sometimes (2)|
+|PS4|Yes (5)|Yes (5)|Yes (5)|Yes (5)|Yes (5)|Yes (5, 6)|No|Yes|No|Sometimes (2)|
 |Switch|Yes|Yes|Yes|Yes|No|No|No|No|Yes|Sometimes (2)|
 
 >__Notes__:
@@ -35,7 +35,7 @@ The following Devices are supported in a way that doesn't require specialized su
 >3. XInput controllers on Mac currently require the installation of the [Xbox Controller Driver for macOS](https://github.com/360Controller/360Controller). Only USB connections are supported by that driver, no wireless dongles. However, the latest generation of Xbox One controllers natively support Bluetooth, and are natively supported on Macs as HIDs without any additional drivers when connected via Bluetooth.
 >4. This includes any XInput-compatible Device.
 >5. Unity doesn't support the gyro or accelerometer on PS4 controllers on platforms other than the PlayStation 4 console at the moment. Also, Unity doesn't support the *DualShock 4 USB Wireless Adaptor*.
->6. Unity supports Mfi certified controllers on iOS.
+>6. Unity supports Mfi certified controllers on iOS. Xbox One and PS4 controllers are only supported on iOS 13 or higher.
 >7. Consoles are supported using separate packages. You need to install these packages in your Project to enable console support.
 
 ### WebGL

Packages/com.unity.inputsystem/InputSystem/InputSystem.cs

@@ -2867,11 +2867,11 @@ private static void RunInitialUpdate()
 #if !UNITY_DISABLE_DEFAULT_INPUT_PLUGIN_INITIALIZATION
         private static void PerformDefaultPluginInitialization()
         {
-            #if UNITY_EDITOR || UNITY_STANDALONE || UNITY_WSA
+            #if UNITY_EDITOR || UNITY_STANDALONE || UNITY_WSA || UNITY_IOS
             XInputSupport.Initialize();
             #endif
 
-            #if UNITY_EDITOR || UNITY_STANDALONE || UNITY_PS4 || UNITY_WSA
+            #if UNITY_EDITOR || UNITY_STANDALONE || UNITY_PS4 || UNITY_WSA || UNITY_IOS
             DualShockSupport.Initialize();
             #endif
 

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

@@ -1,5 +1,6 @@
-#if UNITY_EDITOR || UNITY_IOS || UNITY_TVOS
+#if UNITY_EDITOR || UNITY_IOS || UNITY_TVOS || PACKAGE_DOCS_GENERATION
 using System.Runtime.InteropServices;
+using UnityEngine.InputSystem.DualShock;
 using UnityEngine.InputSystem.Layouts;
 using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.iOS.LowLevel;
@@ -105,10 +106,35 @@ public iOSGameControllerState WithAxis(iOSAxis axis, float value)
 
 namespace UnityEngine.InputSystem.iOS
 {
+    /// <summary>
+    /// A generic Gamepad connected to an iOS device.
+    /// </summary>
+    /// <remarks>
+    /// Any MFi-certified Gamepad which is not an <see cref="XboxOneGampadiOS"/> or <see cref="DualShock4GampadiOS"/> will
+    /// be represented as an iOSGameController.
+    /// </remarks>
     [InputControlLayout(stateType = typeof(iOSGameControllerState), displayName = "iOS Gamepad")]
     [Scripting.Preserve]
     public class iOSGameController : Gamepad
     {
     }
+
+    /// <summary>
+    /// An Xbox One Bluetooth controller connected to an iOS device.
+    /// </summary>
+    [InputControlLayout(stateType = typeof(iOSGameControllerState), displayName = "iOS Xbox One Gamepad")]
+    [Scripting.Preserve]
+    public class XboxOneGampadiOS : UnityEngine.InputSystem.XInput.XInputController
+    {
+    }
+
+    /// <summary>
+    /// A PlayStation DualShock 4 controller connected to an iOS device.
+    /// </summary>
+    [InputControlLayout(stateType = typeof(iOSGameControllerState), displayName = "iOS DualShock 4 Gamepad")]
+    [Scripting.Preserve]
+    public class DualShock4GampadiOS : DualShockGamepad
+    {
+    }
 }
 #endif // UNITY_EDITOR || UNITY_IOS || UNITY_TVOS

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

@@ -16,6 +16,18 @@ public static void Initialize()
                 matches: new InputDeviceMatcher()
                     .WithInterface("iOS")
                     .WithDeviceClass("iOSGameController"));
+
+            InputSystem.RegisterLayout<XboxOneGampadiOS>("XboxOneGampadiOS",
+                matches: new InputDeviceMatcher()
+                    .WithInterface("iOS")
+                    .WithDeviceClass("iOSGameController")
+                    .WithProduct("Xbox Wireless Controller"));
+
+            InputSystem.RegisterLayout<DualShock4GampadiOS>("DualShock4GampadiOS",
+                matches: new InputDeviceMatcher()
+                    .WithInterface("iOS")
+                    .WithDeviceClass("iOSGameController")
+                    .WithProduct("DUALSHOCK 4 Wireless Controller"));
         }
     }
 }