FInputDeviceScope Class Reference

#include <GenericApplicationMessageHandler.h>

Public Member Functions
APPLICATIONCORE_API	FInputDeviceScope (IInputDevice *InInputDevice, FName InInputDeviceName, int32 InHardwareDeviceHandle=-1, FString InHardwareDeviceIdentifier=FString())
APPLICATIONCORE_API	~FInputDeviceScope ()
	FInputDeviceScope ()=delete
	FInputDeviceScope (const FInputDeviceScope &)=delete
FInputDeviceScope &	operator= (const FInputDeviceScope &)=delete
	FInputDeviceScope (FInputDeviceScope &&)=delete
FInputDeviceScope &	operator= (FInputDeviceScope &&)=delete

Static Public Member Functions
static APPLICATIONCORE_API const FInputDeviceScope *	GetCurrent ()

Public Attributes
class IInputDevice *	InputDevice
FName	InputDeviceName
int32	HardwareDeviceHandle
FString	HardwareDeviceIdentifier

Detailed Description

Context scope that indicates which IInputDevice is currently being handled. This can be used to determine hardware-specific information when handling input from FGenericApplicationMessageHandler subclasses. This is generally set during SendControllerEvents or Tick and is only valid on the game thread.

Constructor & Destructor Documentation

FInputDeviceScope() [1/4]

FInputDeviceScope::FInputDeviceScope	(	IInputDevice *	InInputDevice,
		FName	InInputDeviceName,
		int32	InHardwareDeviceHandle = -1,
		FString	InHardwareDeviceIdentifier = FString()
	)

Constructor, this should only be allocated directly on the stack

~FInputDeviceScope()

FInputDeviceScope::~FInputDeviceScope

(

)

FInputDeviceScope() [2/4]

FInputDeviceScope::FInputDeviceScope ( )

delete

Cannot be copied/moved

FInputDeviceScope() [3/4]

FInputDeviceScope::FInputDeviceScope ( const FInputDeviceScope &  )

delete

FInputDeviceScope() [4/4]

FInputDeviceScope::FInputDeviceScope ( FInputDeviceScope &&  )

delete

Member Function Documentation

GetCurrent()

const FInputDeviceScope * FInputDeviceScope::GetCurrent ( )

static

Returns the currently active InputDeviceScope. This is only valid to call on the game thread and may return null

operator=() [1/2]

FInputDeviceScope & FInputDeviceScope::operator= ( const FInputDeviceScope &  )

delete

operator=() [2/2]

FInputDeviceScope & FInputDeviceScope::operator= ( FInputDeviceScope &&  )

delete

Member Data Documentation

HardwareDeviceHandle

int32 FInputDeviceScope::HardwareDeviceHandle

A system-specific device id, this is not the same as controllerId and represents a physical device instead of logical user. -1 represents an unknown device

HardwareDeviceIdentifier

FString FInputDeviceScope::HardwareDeviceIdentifier

Logical string identifying the hardware device. This is not translated and is system-specific, it may be empty

InputDevice

class IInputDevice* FInputDeviceScope::InputDevice

The specific InputDevice that is currently being polled. This is only valid within the current function scope and may be null

InputDeviceName

FName FInputDeviceScope::InputDeviceName

Logical name of the input device interface. This is not translated but is platform-specific

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplicationMessageHandler.h
• Engine/Source/Runtime/ApplicationCore/Private/GenericPlatform/GenericApplication.cpp