Class AndroidGamepad

Represents a gamepad device on Android, providing unified support for various controller types.

Inheritance
object
InputControl
InputDevice
Gamepad
AndroidGamepad
AndroidGamepadWithDpadAxes
AndroidGamepadWithDpadButtons
Implements
Inherited Members
Namespace: UnityEngine.InputSystem.Android
Assembly: Unity.InputSystem.dll
Syntax
public class AndroidGamepad : Gamepad, IDualMotorRumble, IHaptics
Remarks

This layout covers multiple Android-supported gamepads, including but not limited to:

  • ELAN PLAYSTATION(R)3 Controller
  • My-Power CO., LTD. PS(R) Controller Adaptor
  • Sony Interactive Entertainment Wireless (PS4 DualShock)
  • Xbox Wireless Controller (Xbox One)
  • NVIDIA Controller v01.03/v01.04
  • (More may be added later)

Typical Android Axis and Key Mappings

Control Mapping
Left Stick AXIS_X(0) / AXIS_Y(1)
Right Stick AXIS_Z(11) / AXIS_RZ(14)
L1 KEYCODE_BUTTON_L1(102)
R1 KEYCODE_BUTTON_R1(103)
L2 AXIS_BRAKE(23)
R2 AXIS_GAS(22)
Left Thumb KEYCODE_BUTTON_THUMBL(106)
Right Thumb KEYCODE_BUTTON_THUMBR(107)
X KEYCODE_BUTTON_X(99)
Y KEYCODE_BUTTON_Y(100)
B KEYCODE_BUTTON_B(97)
A KEYCODE_BUTTON_A(96)
DPAD AXIS_HAT_X(15), AXIS_HAT_Y(16) or KEYCODE_DPAD_*

Notes

  • NVIDIA Shield Console

    • The L2 and R2 triggers generate both AXIS_BRAKE / AXIS_GAS and AXIS_LTRIGGER / AXIS_RTRIGGER events.
    • On most Android phones, only AXIS_BRAKE and AXIS_GAS are reported; AXIS_LTRIGGER and AXIS_RTRIGGER are not invoked.
    • For consistency across devices, triggers are mapped exclusively to AXIS_BRAKE and AXIS_GAS.
    • The Shield also reports KEYCODE_BACK instead of KEYCODE_BUTTON_SELECT, causing the Options (Xbox), View (DualShock), or Select buttons to be non-functional.

  • PS4 Controller Compatibility

  • Driver-Dependent Behavior

    • Gamepad mappings may differ even between devices running the same Android version.
      • For example, on Android 8.0:
        • NVIDIA Shield Console: buttons map correctly according to AndroidGameControllerState (for example, L1 → ButtonL1, R1 → ButtonR1).
        • Samsung Galaxy S9 / S8 and Xiaomi Mi Note2: mappings are inconsistent (for example, L1 → ButtonY, R1 → ButtonZ).
    • These discrepancies stem from device-specific driver differences, not the Android OS itself.

Because mapping inconsistencies depend on vendor-specific drivers, it’s impractical to maintain per-device remaps.

Implements

Extension Methods