RuntimeVirtualTextureRender.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "RHIAccess.h"
#include "VT/RuntimeVirtualTextureEnum.h"
 
class FRHITexture;
class FRDGBuilder;
class FScene;
class FSceneInterface;
struct IPooledRenderTarget;
class ISceneRenderer;
class URuntimeVirtualTextureComponent;
 
namespace RuntimeVirtualTexture
{
    enum { MaxRenderPageBatch = 8 };
 
    struct FRenderPageTarget
    {
        IPooledRenderTarget* PooledRenderTarget = nullptr;
 
        UE_DEPRECATED(5.6, "Use PooledRenderTarget instead.")
        FRHITexture* Texture = nullptr;
        UE_DEPRECATED(5.6, "PooledRenderTarget tracks its own state.")
        ERHIAccess TextureAccessBefore = ERHIAccess::SRVMask;
        UE_DEPRECATED(5.6, "PooledRenderTarget tracks its own state.")
        ERHIAccess TextureAccessAfter = ERHIAccess::SRVMask;
 
        // Disable deprecation warnings for implicit copying of deprecated members.
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        FRenderPageTarget& operator=(FRenderPageTarget const& RHS) = default;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    };
 
    struct FRenderPageDesc
    {
        uint8 vLevel;
        FBox2D UVRange;
        FIntRect DestRect[MaxTextureLayers];
        UE_DEPRECATED(5.6, "Use DestRect instead.")
        FBox2D DestBox[MaxTextureLayers];
    
        // Disable deprecation warnings for implicit copying of deprecated members.
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        FRenderPageDesc& operator=(FRenderPageDesc const& RHS) = default;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    };
 
    struct FRenderPageBatchDesc
    {
        ISceneRenderer* SceneRenderer;
        UE_DEPRECATED(5.6, "Use SceneRenderer instead.")
        FScene* Scene;
        int32 RuntimeVirtualTextureId;
        UE_DEPRECATED(5.6, "Use RuntimeVirtualTextureId instead.")
        uint32 RuntimeVirtualTextureMask;
        FTransform UVToWorld;
        FBox WorldBounds;
        ERuntimeVirtualTextureMaterialType MaterialType;
        uint8 MaxLevel;
        bool bClearTextures;
        bool bIsThumbnails;
        FLinearColor FixedColor;
        FVector4f CustomMaterialData;
 
        FRenderPageTarget Targets[MaxTextureLayers];
        
        int32 NumPageDescs;
        FRenderPageDesc PageDescs[MaxRenderPageBatch];
 
        // Disable deprecation warnings for implicit copying of deprecated members.
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        FRenderPageBatchDesc& operator=(FRenderPageBatchDesc const& RHS) = default;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    };
 
    class FBatchRenderContext;
 
    RENDERER_API bool IsSceneReadyToRender(FSceneInterface* Scene);
 
    RENDERER_API void RenderPages(FRDGBuilder& GraphBuilder, FRenderPageBatchDesc const& InDesc);
 
    FBatchRenderContext const* InitPageBatch(FRDGBuilder& GraphBuilder, FRenderPageBatchDesc const& InDesc);
    void RenderPageBatch(FRDGBuilder& GraphBuilder, FBatchRenderContext const& InBatch);
    void FinalizePageBatch(FRDGBuilder& GraphBuilder, FBatchRenderContext const& InBatch);
 
    UE_DEPRECATED(5.6, "Use RenderPages().")
    inline void RenderPagesStandAlone(FRDGBuilder& GraphBuilder, FRenderPageBatchDesc const& InDesc)
    {
        RenderPages(GraphBuilder, InDesc);
    }
 
#if WITH_EDITOR
    UE_DEPRECATED(5.6, "Use RuntimeVirtualTextureId everywhere that you would previously use a SceneIndex.")
    RENDERER_API uint32 GetRuntimeVirtualTextureSceneIndex_GameThread(URuntimeVirtualTextureComponent* InComponent);
#endif
}