Navigation
API > API/Runtime > API/Runtime/InputDevice
The public interface of the InputDeviceModule
| Name | IInputDeviceModule |
| Type | class |
| Header File | /Engine/Source/Runtime/InputDevice/Public/IInputDeviceModule.h |
| Include Path | #include "IInputDeviceModule.h" |
Syntax
class IInputDeviceModule :
public IModuleInterface,
public IModularFeature
Implements Interfaces
Derived Classes
IInputDeviceModule derived class hierarchy
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IInputDevice > CreateInputDevice
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler |
Attempts to create a new input device with the given message handler. | IInputDeviceModule.h | |
TSharedPtr< IInputDevice > CreateInputDeviceIfPreferred
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler |
Calls the normal "CreateInputDevice" logic only if this input device module is preferred. | IInputDeviceModule.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< IInputDevice > CreateInputDevice
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler, |
Attempts to create a new input device interface with the specified input device creation parameters. | IInputDeviceModule.h | |
virtual void StartupModule() |
IInputDeviceModule.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const TCHAR * GetPreferredDeviceAPIString() |
Override this function if you would like your IInputDeviceModule to support "Preferred Device API" settings. | IInputDeviceModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IInputDeviceModule & Get() |
Singleton-like access to IInputDeviceModule | IInputDeviceModule.h | |
static FName GetModularFeatureName() |
IInputDeviceModule.h | ||
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IInputDeviceModule.h |