IHeadMountedDisplayModule

The public interface of the HeadmountedDisplay Module

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Public function

TSharedPtr< ...

 

CreateTrackingSystem()

Attempts to create a new head tracking device interface

Public function Static

IHeadMounted...

 

Get()

Singleton-like access to IHeadMountedDisplayModule

Public function Virtual

FString

 

GetAudioInputDevice()

Get name of audio input device where the HMD was last connected

Public function Virtual

FString

 

GetAudioOutputDevice()

Get name of audio output device where the HMD was last connected

Public function Virtual

uint64

 

GetGraphicsAdapterLuid()

Get LUID of graphics adapter where the HMD was last connected.

Public function Static

FName

 

GetModularFeatureName()

Public function Virtual Const

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)

Public function Const

FString

 

GetModuleKeyName()

Returns the key into the HMDPluginPriority section of the config file for this module

Public function Const

float

 

GetModulePriority()

Returns the priority of this module from INI file configuration

Public function Virtual

TSharedPtr< ...

 

GetVulkanExtensions()

Extensions: If the HMD supports the various extensions listed below, it should return a valid pointer to an implementation contained within it.

Public function Static

bool

 

IsAvailable()

Checks to see if there exists a module registered as an HMD.

Public function Virtual

bool

 

IsHMDConnected()

Test to see whether HMD is connected. Used to guide which plug-in to select.

Public function Virtual

bool

 

IsStandaloneStereoOnlyDevice()

Indicates that the device we're currently running does not support a spectator view.

Public function Virtual

bool

 

PreInit()

Optionally pre-initialize the HMD module. Return false on failure.

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

StartupModule()

Register module as an HMD on startup.

Classes

Name

Description

Public struct

FCompareModulePriority

Sorting method for which plug-in should be given priority

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss