FSplashDesc

Structure describing the visual appearance of a single loading splash.

Windows
MacOS
Linux

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/IXRLoadingScreen.h

Include

#include "IXRLoadingScreen.h"

Syntax

struct FSplashDesc

Remarks

Structure describing the visual appearance of a single loading splash.

Splashes are shown in a tracker-relative space with the orientation reset to the direction the player is facing when brought up.

Variables

Name Description

Public variable

bool

 

bIgnoreAlpha

If set, the splash texture will be rendered opaque regardless of the alpha channel. Not supported by all platforms.

Public variable

bool

 

bIsDynamic

Set to true to tell that the texture is dynamically generated and may update each frame.

Public variable

bool

 

bIsExternal

Set this to true if the assigned texture is an external texture, for instance if using the media framework.

Public variable

FQuat

 

DeltaRotation

Simple animation. Rotation that will be applied to the splash every other frame.

Public variable

FTextureRHIRef

 

LeftTexture

If set, overrides the texture shown for the left eye.

Public variable

FVector2D

 

QuadSize

Size of rendered quad in UE units.

Public variable

FTextureRHIRef

 

Texture

The texture shown. Can be set to a 2D or a Cube texture. (Cube textures may not be supported by all platforms.)

Public variable

FTransform

 

Transform

Transform of the splash relative to the HMD orientation and location at the time of showing the loading screen.

Public variable

FBox2D

 

UVRect

UVs of the rendered texture.

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