HeadMountedDisplay

Windows
MacOS
Linux

Classes

Name

Description

Public class

FDefaultSpectatorScreenController

Default implementation of spectator screen controller.

Public class

FDefaultStereoLayers

Default implementation of stereo layers for platforms that require emulating layer support.

Public class

FDefaultXRCamera

Default base implementation of IXRCamera.

Public class

FDefaultXRLoadingScreen

Public class

FDeviceModelLoadedDelegate

UAsyncTask_LoadXRDeviceVisComponent

Public class

FHeadMountedDisplayBase

Default implementation for various IHeadMountedDisplay methods.

Public class

FHMDViewMesh

Public class

FLateUpdateManager

Utility class for applying an offset to a hierarchy of components in the renderer thread.

Public struct

FMotionControllerSource

Motion Controller Source

Named Motion Controller source. Used for UI display

Public class

FMotionDelayClient

FMotionDelayClient

Public class

FMotionDelayService

FMotionDelayService

Public class

FSimpleLayerManager

Public struct

FSpectatorScreenModeTexturePlusEyeLayout

Public struct

FSplashData

Default Loading Screen implementation based on the IStereoLayer interface.

Public struct

FXRDeviceId

Public class

FXRDeviceOnDisconnectDelegate

Public struct

FXRGestureConfig

Public struct

FXRHMDData

Public class

FXRMotionControllerBase

Base utility class for implementations of the IMotionController interface

Public struct

FXRMotionControllerData

Public class

FXRRenderBridge

Public class

FXRRenderTargetManager

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FXRSensorProperties

Struct representing the properties of an external tracking sensor.

Public class

FXRSwapChain

FXRSwapChain.

Public class

FXRTimedInputActionDelegate

Public class

FXRTrackingSystemBase

Base utility class for implementations of the IXRTrackingSystem interface Contains helpers and default implementation of most abstract methods, so final implementations only need to override features that they support.

Public class

FXRTrackingSystemDelegates

Public class

IHandTracker

Public class

IHeadMountedDisplay

HMD device interface

Public class

IHeadMountedDisplayModule

The public interface of the HeadmountedDisplay Module

Public class

IHeadMountedDisplayVulkanExtensions

Query Vulkan extensions required by the HMD.

Public class

IIdentifiableXRDevice

Generic device identifier interface

Public class

IMotionController

Motion Controller device interface

Public class

IMotionTrackingSystemManagement

Motion Tracking System Management interface

Public class

ISpectatorScreenController

Spectator Screen Controller interface

Public class

IXRCamera

Interface used by the camera component to figure out the final position of a motion tracked camera.

Public class

IXRInput

Optional interface returned from IXRTrackingSystem if the plugin requires being able to grab touch or keyboard input events.

Public class

IXRLoadingScreen

Interface used to register and show loading splash screen layers.

Public class

IXRSystemAssets

Public class

IXRSystemIdentifier

Public class

IXRTrackingSystem

Main access point to an XR tracking system. Use it to enumerate devices and query their poses.

Public class

TCircularHistoryBuffer

TCircularHistoryBuffer Modeled after TCircularBuffer/Queue, but resizable with it's own stack-style way of indexing (0 = most recent value added)

Public class

TStereoLayerManager

Partial implementation of the Layer management code for the IStereoLayers interface.

Public class

TXRLoadingScreenBase

Base utility class for implementations of the IXRLoadingScreen interface

Public class

UAsyncTask_LoadXRDeviceVisComponent

Public class

UHandKeypointConversion

Public class

UHeadMountedDisplayFunctionLibrary

Public class

UMotionControllerComponent

Public class

UMotionTrackedDeviceFunctionLibrary

Public class

UVRNotificationsComponent

Copyright Epic Games, Inc.

Public class

UXRAssetFunctionLibrary

UXRAssetFunctionLibrary

Public class

UXRLoadingScreenFunctionLibrary

XR Loading Screen Function Library

Typedefs

Enums

Name

Description

Public enum

EHandKeypoint

Transforms that are tracked on the hand. Matches the enums from WMR to make it a direct mapping

Public enum

EHMDTrackingOrigin::Type

For HMDs that support it, this specifies whether the origin of the tracking universe will be at the floor, or at the user's eye height

Public enum

EHMDWornState::Type

Stores if the user is wearing the HMD or not.

Public enum

EOrientPositionSelector::Type

Public enum

ESpatialInputGestureAxis

Public enum

ESpectatorScreenMode

The Spectator Screen Mode controls what the non-vr video device displays on platforms that support one.

Public enum

ETrackingStatus

Public enum

EXRDeviceConnectionResult::Type

Enumeration of results from Connecting to Remote XR device

Public enum

EXRSystemFlags::Type

Flags to better inform the user about specifics of the underlying XR system

Public enum

EXRTrackedDeviceType

Public enum

EXRVisualType

Functions

Name Description

Public function

FXRSwapChain...

 

CreateXRSwapChain

(
    TArray< FTextureRHIRef >&& InRHITe...,
    const FTextureRHIRef& InRHIAliased...,
    Types... InExtraParameters
)

Public function

void

 

ExecuteOnRenderThread

(
    const TFunctionRef< void()>& Funct...
)

Utility function for easily running a TFunctionRef on the render thread.

Public function

void

 

ExecuteOnRenderThread

(
    const TFunctionRef< void...
)

Utility function for easily running a TFunctionRef on the render thread.

Public function

void

 

ExecuteOnRenderThread_DoNotWait

(
    const TFunction< void()>& Function
)

Utility function for easily submitting TFunction to be run on the render thread.

Public function

void

 

ExecuteOnRenderThread_DoNotWait

(
    const TFunction< void...
)

Utility function for easily submitting TFunction to be run on the render thread.

Public function

void

 

ExecuteOnRHIThread

(
    const TFunctionRef< void()>& Funct...
)

Utility function for easily running a TFunctionRef on the RHI thread.

Public function

void

 

ExecuteOnRHIThread

(
    const TFunctionRef< void...
)

Utility function for easily running a TFunctionRef on the RHI thread.

Public function

bool

 

ExecuteOnRHIThread_DoNotWait

(
    const TFunction< void()>& Function
)

Utility function for easily submitting TFunction to be run on the RHI thread.

Public function

bool

 

ExecuteOnRHIThread_DoNotWait

(
    const TFunction< void...
)

Utility function for easily submitting TFunction to be run on the RHI thread.

Public function

bool

 

GetLayerDescMember

(
    const IStereoLayers::FLayerDesc& L...,
    IStereoLayers::FLayerDesc& OutLaye...
)

Public function

void

 

MarkLayerTextureForUpdate

(
    IStereoLayers::FLayerDesc& Layer
)

Public function

void

 

SetLayerDescMember

(
    IStereoLayers::FLayerDesc& OutLaye...,
    const IStereoLayers::FLayerDesc& I...
)

Variables

Name Description

Public variable

const int32

 

EHandKeypointCount

Public variable

const uint8

 

ESpectatorScreenModeFirst

Public variable

const uint8

 

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