Input_Enums

EDeviceId Enumeration

C++

enum EDeviceId {
  eDI_Keyboard = 0,
  eDI_Mouse = 1,
  eDI_XI = 2,
  eDI_Headmounted = 3,
  eDI_Unknown = 0xff
};

File

IInput.h

EFFEffectId Enumeration

C++

enum EFFEffectId {
  eFF_Rumble_Basic = 0,
  eFF_Rumble_Frame
};

File

IInput.h

EInputDeviceType Enumeration

C++

enum EInputDeviceType {
  eIDT_Keyboard,
  eIDT_Mouse,
  eIDT_Joystick,
  eIDT_Gamepad,
  eIDT_Headmounted
};

File

IInput.h

EInputPlatformFlags Enumeration

C++

enum EInputPlatformFlags {
  eIPF_NONE = 0,
  eIPF_SwapFrontEndForwardAndBack = (1 << 0)
};

File

IInput.h

EInputState Enumeration

Input Event types.

C++

enum EInputState {
  eIS_Unknown = 0,
  eIS_Pressed = (1 << 0),
  eIS_Released = (1 << 1),
  eIS_Down = (1 << 2),
  eIS_Changed = (1 << 3),
  eIS_UI = (1 << 4)
};

File

IInput.h

EKeyId Enumeration

C++

enum EKeyId {
  eKI_Escape = KI_KEYBOARD_BASE,
  eKI_1,
  eKI_2,
  eKI_3,
  eKI_4,
  eKI_5,
  eKI_6,
  eKI_7,
  eKI_8,
  eKI_9,
  eKI_0,
  eKI_Minus,
  eKI_Equals,
  eKI_Backspace,
  eKI_Tab,
  eKI_Q,
  eKI_W,
  eKI_E,
  eKI_R,
  eKI_T,
  eKI_Y,
  eKI_U,
  eKI_I,
  eKI_O,
  eKI_P,
  eKI_LBracket,
  eKI_RBracket,
  eKI_Enter,
  eKI_LCtrl,
  eKI_A,
  eKI_S,
  eKI_D,
  eKI_F,
  eKI_G,
  eKI_H,
  eKI_J,
  eKI_K,
  eKI_L,
  eKI_Semicolon,
  eKI_Apostrophe,
  eKI_Tilde,
  eKI_LShift,
  eKI_Backslash,
  eKI_Z,
  eKI_X,
  eKI_C,
  eKI_V,
  eKI_B,
  eKI_N,
  eKI_M,
  eKI_Comma,
  eKI_Period,
  eKI_Slash,
  eKI_RShift,
  eKI_NP_Multiply,
  eKI_LAlt,
  eKI_Space,
  eKI_CapsLock,
  eKI_F1,
  eKI_F2,
  eKI_F3,
  eKI_F4,
  eKI_F5,
  eKI_F6,
  eKI_F7,
  eKI_F8,
  eKI_F9,
  eKI_F10,
  eKI_NumLock,
  eKI_ScrollLock,
  eKI_NP_7,
  eKI_NP_8,
  eKI_NP_9,
  eKI_NP_Substract,
  eKI_NP_4,
  eKI_NP_5,
  eKI_NP_6,
  eKI_NP_Add,
  eKI_NP_1,
  eKI_NP_2,
  eKI_NP_3,
  eKI_NP_0,
  eKI_F11,
  eKI_F12,
  eKI_F13,
  eKI_F14,
  eKI_F15,
  eKI_Colon,
  eKI_Underline,
  eKI_NP_Enter,
  eKI_RCtrl,
  eKI_NP_Period,
  eKI_NP_Divide,
  eKI_Print,
  eKI_RAlt,
  eKI_Pause,
  eKI_Home,
  eKI_Up,
  eKI_PgUp,
  eKI_Left,
  eKI_Right,
  eKI_End,
  eKI_Down,
  eKI_PgDn,
  eKI_Insert,
  eKI_Delete,
  eKI_LWin,
  eKI_RWin,
  eKI_Apps,
  eKI_OEM_102,
  eKI_Mouse1 = KI_MOUSE_BASE,
  eKI_Mouse2,
  eKI_Mouse3,
  eKI_Mouse4,
  eKI_Mouse5,
  eKI_Mouse6,
  eKI_Mouse7,
  eKI_Mouse8,
  eKI_MouseWheelUp,
  eKI_MouseWheelDown,
  eKI_MouseX,
  eKI_MouseY,
  eKI_MouseZ,
  eKI_MouseXAbsolute,
  eKI_MouseYAbsolute,
  eKI_MouseLast,
  eKI_XI_DPadUp = KI_XINPUT_BASE,
  eKI_XI_DPadDown,
  eKI_XI_DPadLeft,
  eKI_XI_DPadRight,
  eKI_XI_Start,
  eKI_XI_Back,
  eKI_XI_ThumbL,
  eKI_XI_ThumbR,
  eKI_XI_ShoulderL,
  eKI_XI_ShoulderR,
  eKI_XI_A,
  eKI_XI_B,
  eKI_XI_X,
  eKI_XI_Y,
  eKI_XI_TriggerL,
  eKI_XI_TriggerR,
  eKI_XI_ThumbLX,
  eKI_XI_ThumbLY,
  eKI_XI_ThumbLUp,
  eKI_XI_ThumbLDown,
  eKI_XI_ThumbLLeft,
  eKI_XI_ThumbLRight,
  eKI_XI_ThumbRX,
  eKI_XI_ThumbRY,
  eKI_XI_ThumbRUp,
  eKI_XI_ThumbRDown,
  eKI_XI_ThumbRLeft,
  eKI_XI_ThumbRRight,
  eKI_XI_TriggerLBtn,
  eKI_XI_TriggerRBtn,
  eKI_XI_Connect,
  eKI_XI_Disconnect,
  eKI_PS3_Select = KI_PS3_BASE,
  eKI_PS3_L3,
  eKI_PS3_R3,
  eKI_PS3_Start,
  eKI_PS3_Up,
  eKI_PS3_Right,
  eKI_PS3_Down,
  eKI_PS3_Left,
  eKI_PS3_L2,
  eKI_PS3_R2,
  eKI_PS3_L1,
  eKI_PS3_R1,
  eKI_PS3_Triangle,
  eKI_PS3_Circle,
  eKI_PS3_Cross,
  eKI_PS3_Square,
  eKI_PS3_StickLX,
  eKI_PS3_StickLY,
  eKI_PS3_StickRX,
  eKI_PS3_StickRY,
  eKI_PS3_RotX,
  eKI_PS3_RotY,
  eKI_PS3_RotZ,
  eKI_PS3_RotX_KeyL,
  eKI_PS3_RotX_KeyR,
  eKI_PS3_RotZ_KeyD,
  eKI_PS3_RotZ_KeyU,
  eKI_Orbis_Touch,
  eKI_HMD_Pitch = KI_HMD_BASE,
  eKI_HMD_Yaw,
  eKI_HMD_Roll,
  eKI_HMD_Last,
  eKI_SYS_Commit = KI_SYS_BASE,
  eKI_SYS_ConnectDevice,
  eKI_SYS_DisconnectDevice,
  eKI_Unknown = 0xffffffff
};

File

IInput.h

Members

Members	Description
eKI_Mouse1 = KI_MOUSE_BASE	Mouse.
eKI_XI_DPadUp = KI_XINPUT_BASE	X360 controller.
eKI_XI_Connect	should be deprecated because all devices can be connected, use eKI_SYS_ConnectDevice instead
eKI_XI_Disconnect	should be deprecated because all devices can be disconnected, use eKI_SYS_DisconnectDevice instead
eKI_PS3_Select = KI_PS3_BASE	PS3 controller.
eKI_Orbis_Touch	Orbis specific
eKI_HMD_Pitch = KI_HMD_BASE	Head mounted devices (Oculus Rift, Cinemizer, etc...)
eKI_HMD_Last	Must remain the last symbol of HMD devices.
eKI_SYS_Commit = KI_SYS_BASE	Normal inputs should be added above eKI_SYS_COMMIT and below will be ignored by input blocking functionality
eKI_Unknown = 0xffffffff	Terminator.

EKinIdentityMessageCompleteResult Enumeration

C++

enum EKinIdentityMessageCompleteResult {
  EKinIdentityMessageCompleteResult_Ok,
  EKinIdentityMessageCompleteResult_Busy,
  EKinIdentityMessageCompleteResult_LostTrack,
  EKinIdentityMessageCompleteResult_QualityIssue,
  EKinIdentityMessageCompleteResult_Abort
};

File

IInput.h

EKinIdentityMessageId Enumeration

C++

enum EKinIdentityMessageId {
  E_KinIdentityMessageId_Frame_Processed,
  E_KinIdentityMessageId_Id_Complete
};

File

IInput.h

Members

Members	Description
E_KinIdentityMessageId_Frame_Processed	This message-type identifier is sent every time the system has completed processing a single frame, during the identification or enrollment process
E_KinIdentityMessageId_Id_Complete	This message-type identifier is sent when the entire identification or enrollment process is complete

EKinIdentityOperationId Enumeration

C++

enum EKinIdentityOperationId {
  E_KinIdentityOperationId_None,
  E_KinIdentityOperationId_Identify,
  E_KinIdentityOperationId_Enroll,
  E_KinIdentityOperationId_Tuner
};

File

IInput.h

Members

Members	Description
E_KinIdentityOperationId_None	A no-op or an invalid value. The identity engine should never generate a message with this value.
E_KinIdentityOperationId_Identify	A pending IdentityIdentify operation
E_KinIdentityOperationId_Enroll	A pending IdentityEnroll operation
E_KinIdentityOperationId_Tuner	This value is available only if the skeleton tracking part of the Kinect tuner is tested when you captured a XED file

EKinIdentityQuality Enumeration

C++

enum EKinIdentityQuality {
  EKinIdentityQuality_FACE_DETECT_FAILURE = 0x00000001,
  EKinIdentityQuality_USER_BODY_TURNED = 0x00000002,
  EKinIdentityQuality_USER_NOT_UPRIGHT = 0x00000004,
  EKinIdentityQuality_USER_OCCLUDED_FACE = 0x00000008,
  EKinIdentityQuality_USER_OCCLUDED_BODY = 0x00000010,
  EKinIdentityQuality_USER_FAR_AWAY = 0x00000020,
  EKinIdentityQuality_USER_CLOSE = 0x00000040,
  EKinIdentityQuality_USER_CLIPPED_AT_LEFT = 0x00000080,
  EKinIdentityQuality_USER_CLIPPED_AT_RIGHT = 0x00000100,
  EKinIdentityQuality_USER_CLIPPED_AT_TOP = 0x00000200,
  EKinIdentityQuality_USER_CLIPPED_AT_BOTTOM = 0x00000400,
  EKinIdentityQuality_ENVIRONMENT_TOO_DARK = 0x00000800,
  EKinIdentityQuality_ENVIRONMENT_TOO_BRIGHT = 0x00001000
};

File

IInput.h

EModifierMask Enumeration

C++

enum EModifierMask {
  eMM_None = 0,
  eMM_LCtrl = (1 << 0),
  eMM_LShift = (1 << 1),
  eMM_LAlt = (1 << 2),
  eMM_LWin = (1 << 3),
  eMM_RCtrl = (1 << 4),
  eMM_RShift = (1 << 5),
  eMM_RAlt = (1 << 6),
  eMM_RWin = (1 << 7),
  eMM_NumLock = (1 << 8),
  eMM_CapsLock = (1 << 9),
  eMM_ScrollLock = (1 << 10),
  eMM_Ctrl = (eMM_LCtrl | eMM_RCtrl),
  eMM_Shift = (eMM_LShift | eMM_RShift),
  eMM_Alt = (eMM_LAlt | eMM_RAlt),
  eMM_Win = (eMM_LWin | eMM_RWin),
  eMM_Modifiers = (eMM_Ctrl | eMM_Shift | eMM_Alt | eMM_Win),
  eMM_LockKeys = (eMM_CapsLock | eMM_NumLock | eMM_ScrollLock)
};

File

IInput.h

KIN_GRIP_TYPE Enumeration

C++

enum KIN_GRIP_TYPE {
  KIN_GRIP_ANALOG_STICK,
  KIN_GRIP_ARC,
  KIN_GRIP_GEARSHIFT,
  KIN_GRIP_HOVERTIME,
  KIN_GRIP_INVALID
};

File

IInput.h

KIN_IDENTITY_ENROLLMENT Enumeration

C++

enum KIN_IDENTITY_ENROLLMENT {
  KIN_IDENTITY_ENROLLMENT_INDEX_CALL_IDENTIFY = 0xFFFFFFFF,
  KIN_IDENTITY_ENROLLMENT_INDEX_UNKNOWN = 0xFFFFFFFE,
  KIN_IDENTITY_ENROLLMENT_INDEX_BUSY = 0xFFFFFFFC,
  KIN_IDENTITY_ENROLLMENT_INDEX_FAILURE = 0xFFFFFFFB
};

File

IInput.h

KIN_SKELETON_POSITION_INDEX Enumeration

C++

enum KIN_SKELETON_POSITION_INDEX {
  KIN_SKELETON_POSITION_HIP_CENTER = 0,
  KIN_SKELETON_POSITION_SPINE,
  KIN_SKELETON_POSITION_SHOULDER_CENTER,
  KIN_SKELETON_POSITION_HEAD,
  KIN_SKELETON_POSITION_SHOULDER_LEFT,
  KIN_SKELETON_POSITION_ELBOW_LEFT,
  KIN_SKELETON_POSITION_WRIST_LEFT,
  KIN_SKELETON_POSITION_HAND_LEFT,
  KIN_SKELETON_POSITION_SHOULDER_RIGHT,
  KIN_SKELETON_POSITION_ELBOW_RIGHT,
  KIN_SKELETON_POSITION_WRIST_RIGHT,
  KIN_SKELETON_POSITION_HAND_RIGHT,
  KIN_SKELETON_POSITION_HIP_LEFT,
  KIN_SKELETON_POSITION_KNEE_LEFT,
  KIN_SKELETON_POSITION_ANKLE_LEFT,
  KIN_SKELETON_POSITION_FOOT_LEFT,
  KIN_SKELETON_POSITION_HIP_RIGHT,
  KIN_SKELETON_POSITION_KNEE_RIGHT,
  KIN_SKELETON_POSITION_ANKLE_RIGHT,
  KIN_SKELETON_POSITION_FOOT_RIGHT,
  KIN_SKELETON_POSITION_HAND_REFINED_LEFT,
  KIN_SKELETON_POSITION_HAND_REFINED_RIGHT,
  KIN_SKELETON_POSITION_COUNT
};

File

IInput.h

KIN_SKELETON_POSITION_TRACKING_STATE Enumeration

C++

enum KIN_SKELETON_POSITION_TRACKING_STATE {
  KIN_SKELETON_POSITION_NOT_TRACKED = 0,
  KIN_SKELETON_POSITION_INFERRED,
  KIN_SKELETON_POSITION_TRACKED
};

File

IInput.h

KIN_SKELETON_TRACKING_STATE Enumeration

C++

enum KIN_SKELETON_TRACKING_STATE {
  KIN_SKELETON_NOT_TRACKED = 0,
  KIN_SKELETON_POSITION_ONLY,
  KIN_SKELETON_TRACKED
};

File

IInput.h

KIN_SPEECH_CONFIDENCE Enumeration

C++

enum KIN_SPEECH_CONFIDENCE {
  KIN_SPEECH_CONFIDENCE_LOW,
  KIN_SPEECH_CONFIDENCE_NORMAL,
  KIN_SPEECH_CONFIDENCE_HIGHT
};

File

IInput.h

Documentation

Input_Enums