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