FHardwareDeviceIdentifier Struct Reference

#include <InputSettings.h>

Public Member Functions
ENGINE_API	FHardwareDeviceIdentifier ()
ENGINE_API	FHardwareDeviceIdentifier (const FName InClassName, const FName InHardwareDeviceIdentifier, EHardwareDevicePrimaryType InPrimaryType=EHardwareDevicePrimaryType::Unspecified, EHardwareDeviceSupportedFeatures::Type Flags=EHardwareDeviceSupportedFeatures::Unspecified)
ENGINE_API bool	HasAnySupportedFeatures (const EHardwareDeviceSupportedFeatures::Type FlagsToCheck) const
ENGINE_API bool	HasAllSupportedFeatures (const EHardwareDeviceSupportedFeatures::Type FlagsToCheck) const
ENGINE_API bool	IsValid () const
ENGINE_API FString	ToString () const
ENGINE_API bool	operator== (const FHardwareDeviceIdentifier &Other) const
ENGINE_API bool	operator!= (const FHardwareDeviceIdentifier &Other) const

Public Attributes
FName	InputClassName
FName	HardwareDeviceIdentifier
EHardwareDevicePrimaryType	PrimaryDeviceType
int32	SupportedFeaturesMask

Static Public Attributes
static ENGINE_API FHardwareDeviceIdentifier	Invalid
static ENGINE_API FHardwareDeviceIdentifier	DefaultKeyboardAndMouse
static ENGINE_API FHardwareDeviceIdentifier	DefaultGamepad
static ENGINE_API FHardwareDeviceIdentifier	DefaultMobileTouch

Friends
ENGINE_API friend uint32	GetTypeHash (const FHardwareDeviceIdentifier &InDevice)
ENGINE_API friend FArchive &	operator<< (FArchive &Ar, FHardwareDeviceIdentifier &InDevice)

Detailed Description

An identifier that can be used to determine what input devices are available based on the FInputDeviceScope. These mappings should match a FInputDeviceScope that is used by an IInputDevice

Constructor & Destructor Documentation

FHardwareDeviceIdentifier() [1/2]

FHardwareDeviceIdentifier::FHardwareDeviceIdentifier

(

)

FHardwareDeviceIdentifier() [2/2]

FHardwareDeviceIdentifier::FHardwareDeviceIdentifier	(	const FName	InClassName,
		const FName	InHardwareDeviceIdentifier,
		EHardwareDevicePrimaryType	InPrimaryType = EHardwareDevicePrimaryType::Unspecified,
		EHardwareDeviceSupportedFeatures::Type	Flags = EHardwareDeviceSupportedFeatures::Unspecified
	)

Member Function Documentation

HasAllSupportedFeatures()

bool FHardwareDeviceIdentifier::HasAllSupportedFeatures

(

const EHardwareDeviceSupportedFeatures::Type

FlagsToCheck

)

const

Returns true if this hardware device has ALL of the given supported feature flags

HasAnySupportedFeatures()

bool FHardwareDeviceIdentifier::HasAnySupportedFeatures

(

const EHardwareDeviceSupportedFeatures::Type

FlagsToCheck

)

const

Returns true if this hardware device has ANY of the given supported feature flags

IsValid()

bool FHardwareDeviceIdentifier::IsValid

(

)

const

Returns true if this hardware device Identifier has valid names

operator!=()

bool FHardwareDeviceIdentifier::operator!=

(

const FHardwareDeviceIdentifier &

Other

)

const

operator==()

bool FHardwareDeviceIdentifier::operator==

(

const FHardwareDeviceIdentifier &

Other

)

const

ToString()

FString FHardwareDeviceIdentifier::ToString

(

)

const

Returns a string containing the Input Class Name and HardwareDeviceIdentifier properties concatenated together.

Friends And Related Symbol Documentation

GetTypeHash

ENGINE_API friend uint32 GetTypeHash ( const FHardwareDeviceIdentifier &  InDevice )

friend

operator<<

ENGINE_API friend FArchive & operator<< ( FArchive &  Ar, FHardwareDeviceIdentifier &  InDevice  )

friend

Member Data Documentation

DefaultGamepad

FHardwareDeviceIdentifier FHardwareDeviceIdentifier::DefaultGamepad

static

Initial value:

= 
    {
     TEXT("DefaultGamepad"),
     TEXT("Gamepad"),
     EHardwareDevicePrimaryType::Gamepad,
      EHardwareDeviceSupportedFeatures::Type::Gamepad
}

Hardware device ID that represents a default, generic, gamepad.

DefaultKeyboardAndMouse

FHardwareDeviceIdentifier FHardwareDeviceIdentifier::DefaultKeyboardAndMouse

static

Initial value:

= 
    {
         TEXT("DefaultKeyboardAndMouse"),
         TEXT("KBM"),
         EHardwareDevicePrimaryType::KeyboardAndMouse,
         EHardwareDeviceSupportedFeatures::Type::Keypress | EHardwareDeviceSupportedFeatures::Type::Pointer
    }

Hardware device ID that represents a keyboard and mouse. This is what will be set when an Input Event's FKey is not a gamepad key.

DefaultMobileTouch

FHardwareDeviceIdentifier FHardwareDeviceIdentifier::DefaultMobileTouch

static

Initial value:

= 
    {
     TEXT("DefaultMobileTouch"),
     TEXT("MobileTouch"),
     EHardwareDevicePrimaryType::Touch,
     EHardwareDeviceSupportedFeatures::Type::Touch
}

Hardware device id that represents a default, generic, mobile touch input (tablet, phone, etc)

HardwareDeviceIdentifier

FName FHardwareDeviceIdentifier::HardwareDeviceIdentifier

The name of this hardware device. This should correspond with a FInputDeviceScope that is used by an IInputDevice

InputClassName

FName FHardwareDeviceIdentifier::InputClassName

The name of the Input Class that uses this hardware device. This should correspond with a FInputDeviceScope that is used by an IInputDevice

Invalid

FHardwareDeviceIdentifier FHardwareDeviceIdentifier::Invalid

static

Initial value:

=
    {
         NAME_None,
         NAME_None,
         EHardwareDevicePrimaryType::Unspecified,
         EHardwareDeviceSupportedFeatures::Type::Unspecified
    }

An Invalid Hardware Device Identifier.

PrimaryDeviceType

EHardwareDevicePrimaryType FHardwareDeviceIdentifier::PrimaryDeviceType

The generic type that this hardware identifies as. This can be used to easily determine behaviors

SupportedFeaturesMask

int32 FHardwareDeviceIdentifier::SupportedFeaturesMask

Flags that represent this hardware device's traits

---

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

• Engine/Source/Runtime/Engine/Classes/GameFramework/InputSettings.h
• Engine/Source/Runtime/Engine/Private/UserInterface/InputSettings.cpp