Navigation
API > API/Runtime > API/Runtime/HeadMountedDisplay
The public interface of the HeadmountedDisplay Module
| Name | IHeadMountedDisplayModule |
| Type | class |
| Header File | /Engine/Source/Runtime/HeadMountedDisplay/Public/IHeadMountedDisplayModule.h |
| Include Path | #include "IHeadMountedDisplayModule.h" |
Syntax
class IHeadMountedDisplayModule :
public IModuleInterface,
public IModularFeature
Implements Interfaces
Derived Classes
IHeadMountedDisplayModule derived class hierarchy
Structs
| Name | Remarks |
|---|---|
| FCompareModulePriority | Sorting method for which plug-in should be given priority |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< class IXRTrackingSystem, ESPMode::ThreadSafe > CreateTrackingSystem() |
Attempts to create a new head tracking device interface | IHeadMountedDisplayModule.h | |
virtual FString GetAudioInputDevice() |
Get name of audio input device where the HMD was last connected | IHeadMountedDisplayModule.h | |
virtual FString GetAudioOutputDevice() |
Get name of audio output device where the HMD was last connected | IHeadMountedDisplayModule.h | |
virtual FString GetDeviceSystemName() |
Get XR system name | IHeadMountedDisplayModule.h | |
virtual uint64 GetGraphicsAdapterLuid () |
Get LUID of graphics adapter where the HMD was last connected. | IHeadMountedDisplayModule.h | |
virtual void GetModuleAliases
(
TArray< FString >& AliasesOut |
Returns an array of alternative ini/config names for this module (helpful if the module's name changes, so we can have back-compat) | IHeadMountedDisplayModule.h | |
FString GetModuleKeyName() |
Returns the key into the HMDPluginPriority section of the config file for this module | IHeadMountedDisplayModule.h | |
float GetModulePriority() |
Returns the priority of this module from INI file configuration | IHeadMountedDisplayModule.h | |
virtual TSharedPtr< IHeadMountedDisplayVulkanExtensions, ESPMode::ThreadSafe > GetVulkanExtensions() |
Extensions: If the HMD supports the various extensions listed below, it should return a valid pointer to an implementation contained within it. | IHeadMountedDisplayModule.h | |
virtual bool IsHMDConnected() |
Test to see whether HMD is connected. Used to guide which plug-in to select. | IHeadMountedDisplayModule.h | |
virtual bool IsStandaloneStereoOnlyDevice () |
Indicates that the device we're currently running does not support a spectator view. | IHeadMountedDisplayModule.h | |
virtual bool PreInit() |
Optionally pre-initialize the HMD module. Return false on failure. | IHeadMountedDisplayModule.h | |
virtual void StartupModule() |
Register module as an HMD on startup. | IHeadMountedDisplayModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IHeadMountedDisplayModule & Get() |
Singleton-like access to IHeadMountedDisplayModule | IHeadMountedDisplayModule.h | |
static FName GetModularFeatureName() |
IHeadMountedDisplayModule.h | ||
static bool IsAvailable () |
Checks to see if there exists a module registered as an HMD. | IHeadMountedDisplayModule.h |