Navigation
API > API/Plugins > API/Plugins/GameInputBase
IInputDevice interface for the Game Input library. This is a base class that is intended to be implemented on each platform that supports it (Xbox and PC).
This stores all state about every unique Human Interface Device that the GameInput library detects.
Any implementors of this interface should be Created in an IInputDevice module's CreateInputDevice function (IInputDeviceModule::CreateInputDevice), and have it's Initialize function called
| Name | IGameInputDeviceInterface |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GameInput/Source/GameInputBase/Public/IGameInputDeviceInterface.h |
| Include Path | #include "IGameInputDeviceInterface.h" |
Syntax
class IGameInputDeviceInterface : public IInputDevice
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IGameInputDeviceInterface
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler, |
IGameInputDeviceInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IGameInputDeviceInterface() |
IGameInputDeviceInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Initialize () |
Init function that should be called post-construction of this object. | IGameInputDeviceInterface.h |
Public Virtual
Protected Virtual
Overridden from IInputDevice
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Exec
(
UWorld* InWorld, |
IGameInputDeviceInterface.h | ||
virtual EInputDeviceThreadAffinity GetThreadAffinity() |
GameInput polling is designed for multi-threaded access per Microsoft docs. | IGameInputDeviceInterface.h | |
virtual bool IsGamepadAttached() |
IGameInputDeviceInterface.h | ||
virtual void SendControllerEvents() |
IGameInputDeviceInterface.h | ||
virtual void SetChannelValue
(
int32 ControllerId, |
IGameInputDeviceInterface.h | ||
virtual void SetChannelValues
(
int32 ControllerId, |
IGameInputDeviceInterface.h | ||
virtual void SetMessageHandler
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler |
IGameInputDeviceInterface.h | ||
virtual void Tick
(
float DeltaTime |
IGameInputDeviceInterface.h |