IXRLoadingScreen Class Reference

#include <IXRLoadingScreen.h>

Classes
struct	FSplashDesc

Public Member Functions
virtual	~IXRLoadingScreen ()
virtual void	ClearSplashes ()=0
virtual void	AddSplash (const FSplashDesc &Splash)=0
virtual void	ShowLoadingScreen ()=0
virtual void	HideLoadingScreen ()=0
virtual bool	IsShown () const =0
virtual bool	IsPlayingLoadingMovie () const =0

Static Public Member Functions
static HEADMOUNTEDDISPLAY_API void	ShowLoadingScreen_Compat (bool bShow, FTextureRHIRef Texture, const FVector &Offset, const FVector2D &Scale)

Detailed Description

Interface used to register and show loading splash screen layers. A loading screen consists of one or more splash layers shown instead of the current scene during level load.

To reduce duplicated code, implementations should use the FXRLoadingScreenBase of FDefaultXRLoadingScreen instead of implementing this interface directly.

Constructor & Destructor Documentation

~IXRLoadingScreen()

virtual IXRLoadingScreen::~IXRLoadingScreen ( )

inlinevirtual

Member Function Documentation

AddSplash()

virtual void IXRLoadingScreen::AddSplash ( const FSplashDesc &  Splash )

pure virtual

Registers a splash to be shown while the loading screen is active.

Parameters

Splash

The settings for the new splash.

ClearSplashes()

virtual void IXRLoadingScreen::ClearSplashes ( )

pure virtual

Removes all splashes. Use this to replace the existing splashes before calling AddSplash.

HideLoadingScreen()

virtual void IXRLoadingScreen::HideLoadingScreen ( )

pure virtual

Hides the loading screen.

IsPlayingLoadingMovie()

virtual bool IXRLoadingScreen::IsPlayingLoadingMovie ( ) const

pure virtual

Returns whether a loading movie is playing or not.

IsShown()

virtual bool IXRLoadingScreen::IsShown ( ) const

pure virtual

Returns whether the loading screen is currently active or not.

ShowLoadingScreen()

virtual void IXRLoadingScreen::ShowLoadingScreen ( )

pure virtual

Activates the loading screen. If called while the loading screen is active, this will reinitialize the positions of all splashes according to the current HMD pose.

ShowLoadingScreen_Compat()

void IXRLoadingScreen::ShowLoadingScreen_Compat ( bool  bShow, FTextureRHIRef  Texture, const FVector &  Offset, const FVector2D &  Scale  )

static

Internal utility method for implementing backwards compatibility with IStereoLayers::Show/HideSplashScreen. Should be called from implementations overriding IStereoLayer::UpdateSplashScreen()

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/HeadMountedDisplay/Public/IXRLoadingScreen.h
• Engine/Source/Runtime/HeadMountedDisplay/Private/IXRLoadingScreen.cpp