FEnhancedRawInputWindows Class Reference

Windows Implementation. More...

#include <EnhancedRawInputWindows.h>

Inheritance diagram for FEnhancedRawInputWindows:

Public Member Functions
	FEnhancedRawInputWindows (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
virtual void	SetBindings (const FString InterfaceName) override
	Applies the key binding settings to the specified controller.
virtual void	SetAxisBinding (const FString InterfaceName, const int32 AxisUsage, const FName KeyName) override
	Binds a controller axis to a corresponding key.
virtual void	SetButtonBinding (const FString InterfaceName, const int32 ButtonIndex, const FName KeyName) override
	Binds a controller button to a corresponding key.
virtual void	SetPovAxisBinding (const FString InterfaceName, const int32 PovIndex, FName KeyName) override
	Binds a controller POV axis to a corresponding key.
virtual void	SetPovButtonBinding (const FString InterfaceName, const int32 PovIndex, TArray< FName > KeyNames) override
	Binds a controller POV to a corresponding keys.
virtual void	SetChannelValue (int32 ControllerId, FForceFeedbackChannelType ChannelType, float Value) override
virtual void	SetChannelValues (int32 ControllerId, const FForceFeedbackValues &Values) override
virtual bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
virtual void	SetMessageHandler (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler) override
virtual void	Tick (float DeltaTime) override
virtual void	SendControllerEvents () override
virtual bool	SupportsForceFeedback (int32 ControllerId) override
virtual bool	ProcessMessage (HWND Hwnd, uint32 Msg, WPARAM WParam, LPARAM LParam, int32 &OutResult) override
void	EnumerateDevices ()
	Updates the list of all connected controllers. Notifies the engine of any new or removed controllers.
TArray< FHidDevice >	GetConnectedDevices ()
	Returns information about all currently connected devices.
FHidDevice *	FindDeviceByUserAndDeviceId (const FPlatformUserId UserId, const FInputDeviceId DeviceId)
	Finds a device by provided user and device ID.
FHidDevice *	FindDeviceByInterfaceName (const FString &InterfaceName)
	Finds a device by provided interface name.
TMap< int32, FHidAxis >	GetAxisInfo (const FString &InterfaceName)
	Returns information about all axis for a specific device.
TArray< FHidPov >	GetPovInfo (const FString &InterfaceName)
	Returns information about all PoVs / Hat switches / D-PADs for a specific device.
void	SetDeviceActivity (const FString &InterfaceName, bool bIsActive)
	Sets the activity of the device.
DWORD	NotificationCallback (CM_NOTIFY_ACTION Action)
	Internal callback for hotplug detection, not for public use.
Public Member Functions inherited from IEnhancedRawInput
	IEnhancedRawInput (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
FEnhancedRawInputDataDelegate &	GetDataReceivedHandler ()
	Delegate for raw, unprocessed HID data.

Public Attributes
FHidDeviceConnectedDelegate	HidDeviceConnectedHandler
	Event when a HID device is connected.
FHidDeviceConnectedDelegate	HidDeviceDisconnectedHandler
	Event when a HID device is disconnected.

Friends
class	UEnhancedRawInputSettings

Additional Inherited Members
Protected Attributes inherited from IEnhancedRawInput
TSharedRef< FGenericApplicationMessageHandler >	MessageHandler
FEnhancedRawInputDataDelegate	DataReceivedHandler

Detailed Description

Windows Implementation.

Member Function Documentation

FindDeviceByInterfaceName()

FHidDevice * FEnhancedRawInputWindows::FindDeviceByInterfaceName

(

const FString &

InterfaceName

)

Finds a device by provided interface name.

Parameters

InterfaceName

as in

FindDeviceByUserAndDeviceId()

FHidDevice * FEnhancedRawInputWindows::FindDeviceByUserAndDeviceId	(	const FPlatformUserId	UserId,
		const FInputDeviceId	DeviceId )

Finds a device by provided user and device ID.

Parameters

UserId	as reported from engine
DeviceId	as reported from engine

Returns

Pointer to a FHidDevice Struct

GetAxisInfo()

TMap< int32, FHidAxis > FEnhancedRawInputWindows::GetAxisInfo

(

const FString &

InterfaceName

)

Returns information about all axis for a specific device.

Parameters

InterfaceName

Returns

Array of FHidAxis structs

GetConnectedDevices()

TArray< FHidDevice > FEnhancedRawInputWindows::GetConnectedDevices

(

)

Returns information about all currently connected devices.

Returns

Array of FHidDevice Device structs

GetPovInfo()

TArray< FHidPov > FEnhancedRawInputWindows::GetPovInfo

(

const FString &

InterfaceName

)

Returns information about all PoVs / Hat switches / D-PADs for a specific device.

Parameters

InterfaceName

Returns

Array of FHidPov structs

NotificationCallback()

DWORD FEnhancedRawInputWindows::NotificationCallback

(

CM_NOTIFY_ACTION

Action

)

Internal callback for hotplug detection, not for public use.

Parameters

Action

Notify Action

Returns

HRESULT

SetAxisBinding()

void FEnhancedRawInputWindows::SetAxisBinding ( const FString InterfaceName, const int32 AxisUsage, const FName KeyName )

overridevirtual

Binds a controller axis to a corresponding key.

Parameters

InterfaceName	Interface name of the controller
AxisUsage	HID Usage for this axis
KeyName	Name of the Key to be bound

Reimplemented from IEnhancedRawInput.

SetBindings()

void FEnhancedRawInputWindows::SetBindings ( const FString InterfaceName )

overridevirtual

Applies the key binding settings to the specified controller.

Parameters

InterfaceName

Interface name of the controller

Reimplemented from IEnhancedRawInput.

SetButtonBinding()

void FEnhancedRawInputWindows::SetButtonBinding ( const FString InterfaceName, const int32 ButtonIndex, const FName KeyName )

overridevirtual

Binds a controller button to a corresponding key.

Parameters

InterfaceName	Interface name of the controller
ButtonIndex	Index (0 based) of the button
KeyName	Name of the Key to be bound

Reimplemented from IEnhancedRawInput.

SetDeviceActivity()

void FEnhancedRawInputWindows::SetDeviceActivity	(	const FString &	InterfaceName,
		bool	bIsActive )

Sets the activity of the device.

Parameters

InterfaceName
bIsActive

SetPovAxisBinding()

void FEnhancedRawInputWindows::SetPovAxisBinding ( const FString InterfaceName, const int32 PovIndex, FName KeyName )

overridevirtual

Binds a controller POV axis to a corresponding key.

Parameters

InterfaceName	Interface name of the controller
PovIndex	Index (0 based) of the POV
KeyName	Name of the Key to be bound

Reimplemented from IEnhancedRawInput.

SetPovButtonBinding()

void FEnhancedRawInputWindows::SetPovButtonBinding ( const FString InterfaceName, const int32 PovIndex, TArray< FName > KeyNames )

overridevirtual

Binds a controller POV to a corresponding keys.

Parameters

InterfaceName	Interface name of the controller
PovIndex	Index (0 based) of the POV
KeyNames	Name of the Key to be bound

Reimplemented from IEnhancedRawInput.

---

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

• EnhancedRawInputWindows.h
• EnhancedRawInputWindows.cpp