Navigation
API > API/Runtime > API/Runtime/HeadMountedDisplay
Inheritance Hierarchy
- IModuleInterface
- IModularFeature
- IHeadMountedDisplayModule
- IGoogleARCoreBaseModule
- IOpenXRHMDModule
- IPixelStreamingHMDModule
- ISimpleHMDPlugin
References
| Module | HeadMountedDisplay |
| Header | /Engine/Source/Runtime/HeadMountedDisplay/Public/IHeadMountedDisplayModule.h |
| Include | #include "IHeadMountedDisplayModule.h" |
Syntax
class IHeadMountedDisplayModule :
public IModuleInterface,
public IModularFeature
Remarks
The public interface of the HeadmountedDisplay Module
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< class IXRTrackingSystem, ESPMode::ThreadSafe > | Attempts to create a new head tracking device interface | |
  |
IHeadMountedDisplayModule & | Get () |
Singleton-like access to IHeadMountedDisplayModule |
  |
FString | Get name of audio input device where the HMD was last connected | |
  |
FString | Get name of audio output device where the HMD was last connected | |
  |
FString | Get XR system name | |
  |
uint64 | Get LUID of graphics adapter where the HMD was last connected. | |
  |
FName | ||
   |
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) |
  |
FString | Returns the key into the HMDPluginPriority section of the config file for this module | |
  |
float | Returns the priority of this module from INI file configuration | |
  |
TSharedPtr< IHeadMountedDisplayVulkanExtensions, ESPMode::ThreadSafe > | Extensions: If the HMD supports the various extensions listed below, it should return a valid pointer to an implementation contained within it. | |
  |
bool | IsAvailable () |
Checks to see if there exists a module registered as an HMD. |
  |
bool | Test to see whether HMD is connected. Used to guide which plug-in to select. | |
  |
bool | Indicates that the device we're currently running does not support a spectator view. | |
  |
bool | PreInit () |
Optionally pre-initialize the HMD module. Return false on failure. |
Overridden from IModuleInterface
| Type | Name | Description | |
|---|---|---|---|
  |
void | Register module as an HMD on startup. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FCompareModulePriority | Sorting method for which plug-in should be given priority |