Navigation
API > API/Runtime > API/Runtime/HeadMountedDisplay > API/Runtime/HeadMountedDisplay/IXRLoadingScreen
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.
| Name | FSplashDesc |
| Type | struct |
| Header File | /Engine/Source/Runtime/HeadMountedDisplay/Public/IXRLoadingScreen.h |
| Include Path | #include "IXRLoadingScreen.h" |
Syntax
struct FSplashDesc
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS FSplashDesc () |
Silence deprecation warnings for generated uses of Texture and LeftTexture | IXRLoadingScreen.h | |
FSplashDesc
(
const FSplashDesc& |
IXRLoadingScreen.h | ||
FSplashDesc
(
FSplashDesc&& |
IXRLoadingScreen.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIgnoreAlpha | bool | If set, the splash texture will be rendered opaque regardless of the alpha channel. Not supported by all platforms. | IXRLoadingScreen.h | |
| bIsDynamic | bool | Set to true to tell that the texture is dynamically generated and may update each frame. | IXRLoadingScreen.h | |
| bIsExternal | bool | Set this to true if the assigned texture is an external texture, for instance if using the media framework. | IXRLoadingScreen.h | |
| DeltaRotation | FQuat | Simple animation. Rotation that will be applied to the splash every other frame. | IXRLoadingScreen.h | |
| LeftTexture | FTextureRHIRef | IXRLoadingScreen.h | ||
| LeftTextureObj | TWeakObjectPtr< UTexture > | If set, overrides the texture shown for the left eye. | IXRLoadingScreen.h | |
| QuadSize | FVector2D | Size of rendered quad in UE units. | IXRLoadingScreen.h | |
| Texture | FTextureRHIRef | IXRLoadingScreen.h | ||
| TextureObj | TWeakObjectPtr< UTexture > | The texture shown. | IXRLoadingScreen.h | |
| Transform | PRAGMA_ENABLE_DEPRECATION_WARNINGS FTransform | Transform of the splash relative to the HMD orientation and location at the time of showing the loading screen. | IXRLoadingScreen.h | |
| UVRect | FBox2D | UVs of the rendered texture. | IXRLoadingScreen.h |
Functions
Public
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSplashDesc & operator=
(
const FSplashDesc& |
IXRLoadingScreen.h | ||
FSplashDesc & operator=
(
FSplashDesc&& |
IXRLoadingScreen.h |