TXRLoadingScreenBase

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Protected variable

bool

 

bShowing

Protected variable

FQuat

 

HMDOrientation

Protected variable

double

 

LastTimeInSeconds

Protected variable

TArray < SplashT...

 

Splashes

Protected variable

float

 

SystemDisplayInterval

Protected variable

IXRTrackingSyst ...

 

TrackingSystem

Constructors

Name Description

Public function

TXRLoadingScreenBase

(
    IXRTrackingSystem * InTrackingS...
)

Functions

Name Description

Protected function

void

 

ApplyDeltaRotation

(
    const SplashType& Splash
)

Protected function

void

 

DoAddSplash

(
    SplashType& Splash
)

Protected function

void

 

DoDeleteSplash

(
    SplashType& Splash
)

Protected function

void

 

DoHideSplash

(
    SplashType& Splash
)

Protected function

void

 

DoShowSplash

(
    SplashType& Splash
)

Overridden from IXRLoadingScreen

Name Description

Public function Virtual

void

 

AddSplash

(
    const FSplashDesc & Splash
)

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

Public function Virtual

void

 

ClearSplashes()

IXRLoadingScreen interface

Public function Virtual

void

 

HideLoadingScreen()

Hides the loading screen.

Public function Virtual Const

bool

 

IsShown()

Returns whether the loading screen is currently active or not.

Public function Virtual

void

 

ShowLoadingScreen()

Activates the loading screen.

Overridden from FTickableObjectRenderThread

Name Description

Protected function Virtual Const

TStatId

 

GetStatId()

Return the stat id to use for this tickable

Protected function Virtual Const

bool

 

IsTickable()

Pure virtual that must be overloaded by the inheriting class.

Protected function Virtual

void

 

Tick

(
    float DeltaTime
)

FTickableObjectRenderThread interface

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