FInputDeviceScope

Context scope that indicates which [IInputDevice](API\Runtime\InputDevice\IInputDevice) is currently being handled.

Choose your operating system:

Windows

macOS

Linux

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplicationMessageHandler.h

Include

#include "GenericPlatform/GenericApplicationMessageHandler.h"

Syntax

class FInputDeviceScope

Remarks

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.

Variables

Name Description

Public variable

int32

 

HardwareDeviceHandle

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

Public variable

FString

 

HardwareDeviceIdentifier

Logical string identifying the hardware device.

Public variable

IInputDevice &#...

 

InputDevice

The specific InputDevice that is currently being polled.

Public variable

FName

 

InputDeviceName

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

Constructors

Name Description

Public function

FInputDeviceScope()

Cannot be copied/moved

Public function

FInputDeviceScope

(
    const FInputDeviceScope&
)

Public function

FInputDeviceScope

(
    FInputDeviceScope&&
)

Public function

FInputDeviceScope

(
    IInputDevice* InInputDevice,
    FName InInputDeviceName,
    int32 InHardwareDeviceHandle,
    FString InHardwareDeviceIdentifier
)

Constructor, this should only be allocated directly on the stack

Destructors

Name Description

Public function

~FInputDeviceScope()

Functions

Name Description

Public function Static

const FInput...

 

GetCurrent()

Returns the currently active InputDeviceScope.

Operators

Name Description

Public function

FInputDevice...

 

operator=

(
    const FInputDeviceScope&
)

Public function

FInputDevice...

 

operator=

(
    FInputDeviceScope&&
)

Constants

Name

Description

ScopeStack