IXRLoadingScreen

Interface used to register and show loading splash screen layers.

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Public function Virtual

~IXRLoadingScreen()

Functions

Name Description

Public function

void

 

AddSplash

(
    const FSplashDesc & Splash
)

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

Public function

void

 

ClearSplashes()

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

Public function

void

 

HideLoadingScreen()

Hides the loading screen.

Public function Const

bool

 

IsShown()

Returns whether the loading screen is currently active or not.

Public function

void

 

ShowLoadingScreen()

Activates the loading screen.

Public function Static

void

 

ShowLoadingScreen_Compat

(
    bool bShow,
    FTexture2DRHIRef Texture,
    const FVector & Offset,
    const FVector2D & Scale
)

Internal utility method for implementing backwards compatibility with IStereoLayers::Show/HideSplashScreen.

Classes

Name

Description

Public struct

FSplashDesc

Structure describing the visual appearance of a single loading splash.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback