1. Epic GamesDeveloper
  3. XRBase

XRBase

API > API/Plugins

   
Name XRBase
Type Runtime
Part of Plugins XRBase
Location /Engine/Plugins/Runtime/XRBase/Source/XRBase/
Module Build Rules XRBase.Build.cs

Classes

Name Remarks
FDefaultSpectatorScreenController Default implementation of spectator screen controller.
FDefaultStereoLayers Default implementation of stereo layers for platforms that require emulating layer support.
FDefaultXRCamera Default base implementation of IXRCamera.
FDefaultXRLoadingScreen  
FDeviceModelLoadedDelegate UAsyncTask_LoadXRDeviceVisComponent
FHeadMountedDisplayBase Default implementation for various IHeadMountedDisplay methods.
FSimpleLayerManager Partial implementation of the Layer management code for the IStereoLayers interface.
FXRDeviceOnDisconnectDelegate  
FXRMotionControllerBase Base utility class for implementations of the IMotionController interface
FXRMotionControllerBaseLegacy This class adapts deprecated or maintenence only xr plugins which use the old EControllerHand motion sources to the newer FName MotionSource API.
FXRRenderBridge  
FXRRenderTargetManager Common IStereoRenderTargetManager implementation that can be used by HMD implementations in order to get default implementations for most methods.
FXRSwapChain FXRSwapChain.
FXRTimedInputActionDelegate  
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.
FXRTrackingSystemDelegates  
TXRLoadingScreenBase Base utility class for implementations of the IXRLoadingScreen interface
UAsyncTask_LoadXRDeviceVisComponent  
UHeadMountedDisplayFunctionLibrary  
UMotionTrackedDeviceFunctionLibrary  
UVRNotificationsComponent  
UXRAssetFunctionLibrary UXRAssetFunctionLibrary
UXRDeviceVisualizationComponent  
UXRLoadingScreenFunctionLibrary XR Loading Screen Function Library

Structs

Name Remarks
FDefaultStereoLayers_LayerRenderParams Experimental struct
FSplashData Default Loading Screen implementation based on the IStereoLayer interface.
FXRCopyTextureOptions  

Typedefs

Name Type Remarks Include Path
FSpectatorScreenRenderDelegate TBaseDelegate_FiveParams< void, FRHICommandListImmediate &, FTextureRHIRef, FTextureRHIRef, FTextureRHIRef, FVector2D >   DefaultSpectatorScreenController.h
FXRSwapChainPtr TSharedPtr< FXRSwapChain, ESPMode::ThreadSafe >   XRSwapChain.h

Enums

Public

Name Remarks
EXRCopyTextureBlendModifier  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RHICmdList FRHICommandListImmediate & Utility function for easily running a TFunctionRef on the RHI thread. XRThreadUtils.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddXRCopyTexturePass ( FRDGBuilder& GraphBuilder,
FRDGEventName&& Name,
FRDGTextureRef SrcTexture,
FIntRect SrcRect,
FRDGTextureRef DstTexture,
FIntRect DstRect,
const FXRCopyTextureOptions& Options
)

   XRCopyTexture.h  

FXRSwapChainPtr CreateXRSwapChain ( TArray< FTextureRHIRef >&& InRHITextureSwapChain,
const FTextureRHIRef& InRHIAliasedTexture,
Types... InExtraParameters
)

   XRSwapChain.h  

RHICmdList EnqueueLambda ( ...
)

   XRThreadUtils.h  

void ExecuteOnRenderThread ( const TFunctionRef< void()>& Function
)

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

void ExecuteOnRenderThread ( const TFunctionRef< void(FRHICommandListImmediate&)>& Function
)

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

void ExecuteOnRenderThread_DoNotWait ( const TFunction< void()>& Function
)

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

void ExecuteOnRenderThread_DoNotWait ( const TFunction< void(FRHICommandListImmediate&)>& Function
)

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

Ideally systems would be refactored to avoid having to flush though void ExecuteOnRHIThread ( const TFunctionRef< void()>& Function
)

   XRThreadUtils.h  

Ideally systems would be refactored to avoid having to flush though void ExecuteOnRHIThread ( const TFunctionRef< void(FRHICommandListImmediate&)>& Function
)

   XRThreadUtils.h  

bool ExecuteOnRHIThread_DoNotWait ( const TFunction< void()>& Function
)

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

bool ExecuteOnRHIThread_DoNotWait ( const TFunction< void(FRHICommandListImmediate&)>& Function
)

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

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool GetLayerDescMember ( const IStereoLayers::FLayerDesc& Layer,
IStereoLayers::FLayerDesc& OutLayerDesc
)

   StereoLayerManager.h  

RHICmdList ImmediateFlush ( EImmediateFlushType::FlushRHIThread
)

   XRThreadUtils.h  

void MarkLayerTextureForUpdate ( IStereoLayers::FLayerDesc& Layer
)

   StereoLayerManager.h  

void SetLayerDescMember ( IStereoLayers::FLayerDesc& OutLayer,
const IStereoLayers::FLayerDesc& InLayerDesc
)

   StereoLayerManager.h  

void XRCopyTexture_InRenderPass ( FRHICommandListImmediate& RHICmdList,
FRHITexture* SrcTexture,
FIntRect SrcRect,
FRHITexture* DstTexture,
FIntRect DstRect,
const FXRCopyTextureOptions& Options,
uint32 ArraySlice,
uint32 MipLevel
)

   XRCopyTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page