IInputDevice

Input device interface. Useful for plugins/modules to support custom external input devices.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IInputDevice

IRawInput

References

Module

InputDevice

Header

/Engine/Source/Runtime/InputDevice/Public/IInputDevice.h

Include

#include "IInputDevice.h"

Syntax

class IInputDevice

Remarks

Input device interface. Useful for plugins/modules to support custom external input devices.

Destructors

Name Description

Public function Virtual

~IInputDevice()

Functions

Name Description

Public function

bool

 

Exec

(
    UWorld* InWorld,
    const TCHAR* Cmd,
    FOutputDevice& Ar
)

Exec handler to allow console commands to be passed through for debugging

Public function Virtual

IHapticDevic...

 

GetHapticDevice()

If this device supports a haptic interface, implement this, and inherit the IHapticDevice interface

Public function Virtual Const

bool

 

IsGamepadAttached()

Public function Virtual

void

 

ResetLightColor

(
    int32 ControllerId
)

Public function

void

 

SendControllerEvents()

Poll for controller state and send events if needed

Public function

void

 

SetChannelValue

(
    int32 ControllerId,
    FForceFeedbackChannelType ChannelTy...,
    float Value
)

IForceFeedbackSystem pass through functions

Public function

void

 

SetChannelValues

(
    int32 ControllerId,
    const FForceFeedbackValues& values
)

Public function Virtual

void

 

SetDeviceProperty

(
    int32 ControllerId,
    const FInputDeviceProperty* Pr...
)

Sets a property for a given controller id.

Public function Virtual

void

 

SetLightColor

(
    int32 ControllerId,
    FColor Color
)

Pass though functions for light color

Public function

void

 

SetMessageHandler

(
    const TSharedRef< FGenericApplicati...
)

Set which MessageHandler will get the events from SendControllerEvents.

Public function Virtual

bool

 

SupportsForceFeedback

(
    int32 ControllerId
)

Public function

void

 

Tick

(
    float DeltaTime
)

Tick the interface (e.g. check for new controllers)