FInputDeviceState

Current state of physical input devices at a point in time.

Windows
MacOS
Linux

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InputState.h

Include

#include "InputState.h"

Syntax

struct FInputDeviceState

Remarks

Current state of physical input devices at a point in time. Assumption is that the state refers to a single physical input device, ie InputDevice field is a single value of EInputDevices and not a combination.

Variables

Name Description

Public variable

bool

 

bAltKeyDown

Is they keyboard ALT modifier key currently pressed down

Public variable

bool

 

bCmdKeyDown

Is they keyboard CMD modifier key currently pressed down (only on Apple devices)

Public variable

bool

 

bCtrlKeyDown

Is they keyboard CTRL modifier key currently pressed down

Public variable

bool

 

bShiftKeyDown

Keyboard modifiersIs they keyboard SHIFT modifier key currently pressed down

Public variable

EInputDevices

 

InputDevice

Which InputDevice member is valid in this state

Public variable

FKeyboardInputD...

 

Keyboard

Current state of Keyboard device, if InputDevice == EInputDevices::Keyboard

Public variable

FMouseInputDevi...

 

Mouse

Current state of Mouse device, if InputDevice == EInputDevices::Mouse

Constructors

Name Description

Public function

FInputDeviceState()

Functions

Name Description

Public function Static

bool

 

IsAltKeyDown

(
    const FInputDeviceState& InputStat...
)

Public function Static

bool

 

IsCmdKeyDown

(
    const FInputDeviceState& InputStat...
)

Public function Static

bool

 

IsCtrlKeyDown

(
    const FInputDeviceState& InputStat...
)

Public function Const

bool

 

IsFromDevice

(
    EInputDevices DeviceType
)

Public function Static

bool

 

IsShiftKeyDown

(
    const FInputDeviceState& InputStat...
)

Utility functions to pass as lambdas

Public function

void

 

SetModifierKeyStates

(
    bool bShiftDown,
    bool bAltDown,
    bool bCtrlDown,
    bool bCmdDown
)

Update keyboard modifier key states

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss