UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AndroidInputInterface.h File Reference
#include "GenericPlatform/GenericApplicationMessageHandler.h"
#include <android/input.h>
#include <android/keycodes.h>
#include <android/api-level.h>
#include "GenericPlatform/ICursor.h"
#include "GenericPlatform/IInputInterface.h"
#include "GenericPlatform/GenericInputDeviceMap.h"
#include "Math/Vector.h"
#include "Math/Vector2D.h"
#include "Math/Color.h"

Go to the source code of this file.

Classes

struct  FAndroidInputDeviceInfo
 
struct  TouchInput
 
struct  FAndroidControllerData
 
struct  FAndroidControllerVibeState
 
struct  FAndroidGamepadDeviceMapping
 
struct  FDeferredAndroidMessage
 
class  FAndroidInputInterface
 

Macros

#define MAX_NUM_CONTROLLERS   8
 
#define MAX_NUM_PHYSICAL_CONTROLLER_BUTTONS   18
 
#define MAX_NUM_VIRTUAL_CONTROLLER_BUTTONS   8
 
#define MAX_NUM_CONTROLLER_BUTTONS   MAX_NUM_PHYSICAL_CONTROLLER_BUTTONS + MAX_NUM_VIRTUAL_CONTROLLER_BUTTONS
 
#define MAX_DEFERRED_MESSAGE_QUEUE_SIZE   128
 

Enumerations

enum  {
  AMOTION_EVENT_AXIS_X = 0 , AMOTION_EVENT_AXIS_Y = 1 , AMOTION_EVENT_AXIS_PRESSURE = 2 , AMOTION_EVENT_AXIS_SIZE = 3 ,
  AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4 , AMOTION_EVENT_AXIS_TOUCH_MINOR = 5 , AMOTION_EVENT_AXIS_TOOL_MAJOR = 6 , AMOTION_EVENT_AXIS_TOOL_MINOR = 7 ,
  AMOTION_EVENT_AXIS_ORIENTATION = 8 , AMOTION_EVENT_AXIS_VSCROLL = 9 , AMOTION_EVENT_AXIS_HSCROLL = 10 , AMOTION_EVENT_AXIS_Z = 11 ,
  AMOTION_EVENT_AXIS_RX = 12 , AMOTION_EVENT_AXIS_RY = 13 , AMOTION_EVENT_AXIS_RZ = 14 , AMOTION_EVENT_AXIS_HAT_X = 15 ,
  AMOTION_EVENT_AXIS_HAT_Y = 16 , AMOTION_EVENT_AXIS_LTRIGGER = 17 , AMOTION_EVENT_AXIS_RTRIGGER = 18 , AMOTION_EVENT_AXIS_THROTTLE = 19 ,
  AMOTION_EVENT_AXIS_RUDDER = 20 , AMOTION_EVENT_AXIS_WHEEL = 21 , AMOTION_EVENT_AXIS_GAS = 22 , AMOTION_EVENT_AXIS_BRAKE = 23 ,
  AMOTION_EVENT_AXIS_DISTANCE = 24 , AMOTION_EVENT_AXIS_TILT = 25 , AMOTION_EVENT_AXIS_GENERIC_1 = 32 , AMOTION_EVENT_AXIS_GENERIC_2 = 33 ,
  AMOTION_EVENT_AXIS_GENERIC_3 = 34 , AMOTION_EVENT_AXIS_GENERIC_4 = 35 , AMOTION_EVENT_AXIS_GENERIC_5 = 36 , AMOTION_EVENT_AXIS_GENERIC_6 = 37 ,
  AMOTION_EVENT_AXIS_GENERIC_7 = 38 , AMOTION_EVENT_AXIS_GENERIC_8 = 39 , AMOTION_EVENT_AXIS_GENERIC_9 = 40 , AMOTION_EVENT_AXIS_GENERIC_10 = 41 ,
  AMOTION_EVENT_AXIS_GENERIC_11 = 42 , AMOTION_EVENT_AXIS_GENERIC_12 = 43 , AMOTION_EVENT_AXIS_GENERIC_13 = 44 , AMOTION_EVENT_AXIS_GENERIC_14 = 45 ,
  AMOTION_EVENT_AXIS_GENERIC_15 = 46 , AMOTION_EVENT_AXIS_GENERIC_16 = 47
}
 
enum  { AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010 }
 
enum  { AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON , AINPUT_SOURCE_JOYSTICK = 0x01000000 | AINPUT_SOURCE_CLASS_JOYSTICK }
 
enum  InputDeviceType { UnknownInputDeviceType , TouchScreen , GameController }
 
enum  TouchType { TouchBegan , TouchMoved , TouchEnded }
 
enum class  InputDeviceStateEvent { Added = 0 , Removed , Changed }
 
enum  MappingState { Unassigned = 0 , ToActivate , ToValidate , Valid }
 
enum  ControllerClassType { Generic , XBoxWired , XBoxWireless , PlaystationWireless }
 
enum  ButtonRemapType {
  Normal , XBox , PS4 , PS5 ,
  PS5New
}
 
enum  FAndroidMessageType { MessageType_KeyDown , MessageType_KeyUp }
 

Macro Definition Documentation

◆ MAX_DEFERRED_MESSAGE_QUEUE_SIZE

#define MAX_DEFERRED_MESSAGE_QUEUE_SIZE   128

◆ MAX_NUM_CONTROLLER_BUTTONS

◆ MAX_NUM_CONTROLLERS

#define MAX_NUM_CONTROLLERS   8

◆ MAX_NUM_PHYSICAL_CONTROLLER_BUTTONS

#define MAX_NUM_PHYSICAL_CONTROLLER_BUTTONS   18

◆ MAX_NUM_VIRTUAL_CONTROLLER_BUTTONS

#define MAX_NUM_VIRTUAL_CONTROLLER_BUTTONS   8

Enumeration Type Documentation

◆ anonymous enum

Enumerator
AMOTION_EVENT_AXIS_X 
AMOTION_EVENT_AXIS_Y 
AMOTION_EVENT_AXIS_PRESSURE 
AMOTION_EVENT_AXIS_SIZE 
AMOTION_EVENT_AXIS_TOUCH_MAJOR 
AMOTION_EVENT_AXIS_TOUCH_MINOR 
AMOTION_EVENT_AXIS_TOOL_MAJOR 
AMOTION_EVENT_AXIS_TOOL_MINOR 
AMOTION_EVENT_AXIS_ORIENTATION 
AMOTION_EVENT_AXIS_VSCROLL 
AMOTION_EVENT_AXIS_HSCROLL 
AMOTION_EVENT_AXIS_Z 
AMOTION_EVENT_AXIS_RX 
AMOTION_EVENT_AXIS_RY 
AMOTION_EVENT_AXIS_RZ 
AMOTION_EVENT_AXIS_HAT_X 
AMOTION_EVENT_AXIS_HAT_Y 
AMOTION_EVENT_AXIS_LTRIGGER 
AMOTION_EVENT_AXIS_RTRIGGER 
AMOTION_EVENT_AXIS_THROTTLE 
AMOTION_EVENT_AXIS_RUDDER 
AMOTION_EVENT_AXIS_WHEEL 
AMOTION_EVENT_AXIS_GAS 
AMOTION_EVENT_AXIS_BRAKE 
AMOTION_EVENT_AXIS_DISTANCE 
AMOTION_EVENT_AXIS_TILT 
AMOTION_EVENT_AXIS_GENERIC_1 
AMOTION_EVENT_AXIS_GENERIC_2 
AMOTION_EVENT_AXIS_GENERIC_3 
AMOTION_EVENT_AXIS_GENERIC_4 
AMOTION_EVENT_AXIS_GENERIC_5 
AMOTION_EVENT_AXIS_GENERIC_6 
AMOTION_EVENT_AXIS_GENERIC_7 
AMOTION_EVENT_AXIS_GENERIC_8 
AMOTION_EVENT_AXIS_GENERIC_9 
AMOTION_EVENT_AXIS_GENERIC_10 
AMOTION_EVENT_AXIS_GENERIC_11 
AMOTION_EVENT_AXIS_GENERIC_12 
AMOTION_EVENT_AXIS_GENERIC_13 
AMOTION_EVENT_AXIS_GENERIC_14 
AMOTION_EVENT_AXIS_GENERIC_15 
AMOTION_EVENT_AXIS_GENERIC_16 

◆ anonymous enum

Enumerator
AINPUT_SOURCE_CLASS_JOYSTICK 

◆ anonymous enum

Enumerator
AINPUT_SOURCE_GAMEPAD 
AINPUT_SOURCE_JOYSTICK 

◆ ButtonRemapType

Enumerator
Normal 
XBox 
PS4 
PS5 
PS5New 

◆ ControllerClassType

Enumerator
Generic 
XBoxWired 
XBoxWireless 
PlaystationWireless 

◆ FAndroidMessageType

Enumerator
MessageType_KeyDown 
MessageType_KeyUp 

◆ InputDeviceStateEvent

Enumerator
Added 
Removed 
Changed 

◆ InputDeviceType

Enumerator
UnknownInputDeviceType 
TouchScreen 
GameController 

◆ MappingState

Enumerator
Unassigned 
ToActivate 
ToValidate 
Valid 

◆ TouchType

Enumerator
TouchBegan 
TouchMoved 
TouchEnded