Navigation
API > API/Runtime > API/Runtime/HeadMountedDisplay
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.
| Name | IXRLoadingScreen |
| Type | class |
| Header File | /Engine/Source/Runtime/HeadMountedDisplay/Public/IXRLoadingScreen.h |
| Include Path | #include "IXRLoadingScreen.h" |
Syntax
class IXRLoadingScreen
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IXRLoadingScreen() |
IXRLoadingScreen.h |
Structs
| Name | Remarks |
|---|---|
| FSplashDesc | Structure describing the visual appearance of a single loading splash. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddSplash
(
const FSplashDesc& Splash |
Registers a splash to be shown while the loading screen is active. | IXRLoadingScreen.h | |
void ClearSplashes() |
Removes all splashes. Use this to replace the existing splashes before calling AddSplash. | IXRLoadingScreen.h | |
void HideLoadingScreen() |
Hides the loading screen. | IXRLoadingScreen.h | |
bool IsPlayingLoadingMovie() |
Returns whether a loading movie is playing or not. | IXRLoadingScreen.h | |
bool IsShown() |
Returns whether the loading screen is currently active or not. | IXRLoadingScreen.h | |
void ShowLoadingScreen () |
Activates the loading screen. | IXRLoadingScreen.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ShowLoadingScreen_Compat
(
bool bShow, |
Internal utility method for implementing backwards compatibility with IStereoLayers::Show/HideSplashScreen. | IXRLoadingScreen.h |