Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > InteractiveToolsFramework > FInputDeviceState

Light Theme

Dark Theme

FInputDeviceState

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

Choose your operating system:

Windows

macOS

Linux

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/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
bool	bAltKeyDown	Is they keyboard ALT modifier key currently pressed down
bool	bCmdKeyDown	Is they keyboard CMD modifier key currently pressed down (only on Apple devices)
bool	bCtrlKeyDown	Is they keyboard CTRL modifier key currently pressed down
bool	bShiftKeyDown	Keyboard modifiersIs they keyboard SHIFT modifier key currently pressed down
EInputDevices	InputDevice	Which InputDevice member is valid in this state
FKeyboardInputD...	Keyboard	Current state of Keyboard device, if InputDevice == EInputDevices::Keyboard
FMouseInputDevi...	Mouse	Current state of Mouse device, if InputDevice == EInputDevices::Mouse

Constructors

	Name	Description
	FInputDeviceState()

Functions

	Name	Description
bool	IsAltKeyDown ( const FInputDeviceState& InputStat... )
bool	IsCmdKeyDown ( const FInputDeviceState& InputStat... )
bool	IsCtrlKeyDown ( const FInputDeviceState& InputStat... )
bool	IsFromDevice ( EInputDevices DeviceType )
bool	IsShiftKeyDown ( const FInputDeviceState& InputStat... )	Utility functions to pass as lambdas
void	SetModifierKeyStates ( bool bShiftDown, bool bAltDown, bool bCtrlDown, bool bCmdDown )	Update keyboard modifier key states