StereoRenderTargetManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc.All Rights Reserved.
 
/*=============================================================================
StereoRenderTargetManager.h: Abstract interface returned from IStereoRendering to support rendering into a texture
=============================================================================*/
 
#pragma once
#include "CoreMinimal.h"
#include "Engine/GameViewportClient.h"
#include "PixelFormat.h"
 
class FRHITexture;
enum class ETextureCreateFlags : uint64;
enum EShaderPlatform : uint16;
typedef TRefCountPtr<FRHITexture> FTextureRHIRef;
 
class IStereoRenderTargetManager
{
public:
    virtual bool ShouldUseSeparateRenderTarget() const = 0;
 
    virtual void UpdateViewport(bool bUseSeparateRenderTarget, const class FViewport& Viewport, class SViewport* ViewportWidget = nullptr) = 0;
 
    virtual void CalculateRenderTargetSize(const class FViewport& Viewport, uint32& InOutSizeX, uint32& InOutSizeY) = 0;
 
    virtual bool NeedReAllocateViewportRenderTarget(const class FViewport& Viewport) = 0;
 
    UE_DEPRECATED(5.2, "Return true in NeedReAllocateViewportRenderTarget instead")
    virtual bool NeedReAllocateDepthTexture(const TRefCountPtr<struct IPooledRenderTarget>& DepthTarget) { return false; }
 
    virtual bool NeedReAllocateShadingRateTexture(const TRefCountPtr<struct IPooledRenderTarget>& ShadingRateTarget) { return false; }
 
    UE_DEPRECATED(5.2, "Inferred from the array size returned in AllocateRenderTargetTextures")
    virtual uint32 GetNumberOfBufferedFrames() const { return 1; }
 
    UE_DEPRECATED(5.2, "Implement AllocateRenderTargetTextures to allocate all textures at once")
    virtual bool AllocateRenderTargetTexture(uint32 Index, uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ETextureCreateFlags TargetableTextureFlags, FTextureRHIRef& OutTargetableTexture, FTextureRHIRef& OutShaderResourceTexture, uint32 NumSamples = 1) { return false; }
 
    virtual bool AllocateRenderTargetTextures(uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumLayers, ETextureCreateFlags Flags, ETextureCreateFlags TargetableTextureFlags, TArray<FTextureRHIRef>& OutTargetableTextures, TArray<FTextureRHIRef>& OutShaderResourceTextures, uint32 NumSamples = 1) { return false; }
 
    virtual EPixelFormat GetActualColorSwapchainFormat() const { return PF_Unknown; }
 
    virtual int32 AcquireColorTexture() { return -1; }
    
    virtual int32 AcquireDepthTexture() { return -1; }
 
    virtual bool AllocateDepthTexture(uint32 Index, uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ETextureCreateFlags TargetableTextureFlags, FTextureRHIRef& OutTargetableTexture, FTextureRHIRef& OutShaderResourceTexture, uint32 NumSamples = 1) { return false; }
 
    virtual bool AllocateShadingRateTexture(uint32 Index, uint32 RenderSizeX, uint32 RenderSizeY, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ETextureCreateFlags TargetableTextureFlags, FTextureRHIRef& OutTexture, FIntPoint& OutTextureSize) { return false; }
 
    virtual bool HDRGetMetaDataForStereo(EDisplayOutputFormat& OutDisplayOutputFormat, EDisplayColorGamut& OutDisplayColorGamut, bool& OutbHDRSupported) { return false; }
 
    virtual bool ReconfigureForShaderPlatform(EShaderPlatform NewShaderPlatform) { return false; };
 
    virtual bool GetRecommendedMotionVectorTextureSize(FIntPoint& OutTextureSize) { return false; }
    
    virtual bool GetMotionVectorTexture(uint32 Index, const FIntPoint& Size, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, FTextureRHIRef& OutTexture, uint32 NumSamples = 1) { return false; }
    
    virtual bool GetMotionVectorDepthTexture(uint32 Index, const FIntPoint& Size, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, FTextureRHIRef& OutTexture, uint32 NumSamples = 1) { return false; }
    
    static EPixelFormat GetStereoLayerPixelFormat() { return PF_B8G8R8A8; }
};