Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

TXRLoadingScreenBase

Base utility class for implementations of the [IXRLoadingScreen](API\Runtime\HeadMountedDisplay\IXRLoadingScreen) interface

Windows

MacOS

Linux

Inheritance Hierarchy

IXRLoadingScreen

FTickableObjectRenderThread

TXRLoadingScreenBase

FDefaultXRLoadingScreen

References

Module	HeadMountedDisplay
Header	/Engine/Source/Runtime/HeadMountedDisplay/Public/XRLoadingScreenBase.h
Include	#include "XRLoadingScreenBase.h"

Syntax

template<typename SplashType>
class TXRLoadingScreenBase :
public IXRLoadingScreen,
protected FTickableObjectRenderThread

Remarks

Base utility class for implementations of the IXRLoadingScreen interface

Variables

Constructors

	Name	Description
	TXRLoadingScreenBase ( IXRTrackingSystem* InTrackingS... )

Functions

		Name	Description
	void	ApplyDeltaRotation ( const SplashType& Splash )
	void	DoAddSplash ( SplashType& Splash )
	void	DoDeleteSplash ( SplashType& Splash )
	void	DoHideSplash ( SplashType& Splash )
	void	DoShowSplash ( SplashType& Splash )

Overridden from IXRLoadingScreen

	Name	Description
void	AddSplash ( const FSplashDesc& Splash )	Registers a splash to be shown while the loading screen is active.
void	ClearSplashes()	IXRLoadingScreen interface
void	HideLoadingScreen()	Hides the loading screen.
bool	IsShown()	Returns whether the loading screen is currently active or not.
void	ShowLoadingScreen()	Activates the loading screen.

Overridden from FTickableObjectRenderThread

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
bool	IsTickable()	Pure virtual that must be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	FTickableObjectRenderThread interface

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

Take our survey

Dismiss