IXRLoadingScreen.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HeadMountedDisplayTypes.h"
#include "UObject/WeakObjectPtrTemplates.h"
#include "Engine/Texture.h"
 
 
class  IXRLoadingScreen 
{
public:
 
    virtual ~IXRLoadingScreen() {}
 
    struct FSplashDesc
    {
        // silence deprecation warnings for generated uses of Texture and LeftTexture
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        FSplashDesc() = default;
        FSplashDesc(const FSplashDesc&) = default;
        FSplashDesc(FSplashDesc&&) = default;
        FSplashDesc& operator=(const FSplashDesc&) = default;
        FSplashDesc& operator=(FSplashDesc&&) = default;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
        // Transform of the splash relative to the HMD orientation and location at the time of showing the loading screen.
        FTransform  Transform = FTransform::Identity;
        // Size of rendered quad in UE units
        FVector2D   QuadSize = FVector2D(1.0f, 1.0f);
        // UVs of the rendered texture
        FBox2D      UVRect = FBox2D(FVector2D(0.0f, 0.0f), FVector2D(1.0f, 1.0f));
        
        // Simple animation. Rotation that will be applied to the splash every other frame.
        FQuat       DeltaRotation = FQuat::Identity;
 
        // If set, the splash texture will be rendered opaque regardless of the alpha channel. Not supported by all platforms.
        bool        bIgnoreAlpha = false;
 
        // Set to true to tell that the texture is dynamically generated and may update each frame.
        bool        bIsDynamic   = false;
        
        // Set this to true if the assigned texture is an external texture, for instance if using the media framework.
        bool        bIsExternal  = false;
 
        // The texture shown. Can be set to a 2D or a Cube texture. (Cube textures may not be supported by all platforms.)
        // Implementations of IXRLoadingScreen will prevent GC of these pointers for any stored splashes.
        TWeakObjectPtr<UTexture>    TextureObj = nullptr;
        UE_DEPRECATED(5.6, "Use TextureObj instead")
        FTextureRHIRef              Texture = nullptr;
 
        // If set, overrides the texture shown for the left eye. If null, both eyes will show the same texture.
        // Useful for stereo texture cubes.
        // Implementations of IXRLoadingScreen will prevent GC of these pointers for any stored splashes.
        TWeakObjectPtr<UTexture>    LeftTextureObj = nullptr;
        UE_DEPRECATED(5.6, "Use LeftTextureObj instead")
        FTextureRHIRef              LeftTexture = nullptr;
    };
 
    virtual void ClearSplashes() = 0;
 
    virtual void AddSplash(const FSplashDesc& Splash) = 0;
 
    virtual void ShowLoadingScreen() = 0;
 
    virtual void HideLoadingScreen() = 0;
 
    virtual bool IsShown() const = 0;
 
    virtual bool IsPlayingLoadingMovie() const = 0;
 
    UE_DEPRECATED(5.6, "This unused function will be removed. Use IXRLoadingScreen::AddSplash instead")
    static HEADMOUNTEDDISPLAY_API void ShowLoadingScreen_Compat(bool bShow, FTextureRHIRef Texture, const FVector& Offset, const FVector2D& Scale);
};