MeshElementCollector.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MeshBatch.h"
#include "RendererInterface.h"
 
class FGlobalDynamicIndexBuffer;
class FGlobalDynamicReadBuffer;
class FGlobalDynamicVertexBuffer;
class FGPUScenePrimitiveCollector;
class FMaterialRenderProxy;
class FPrimitiveDrawInterface;
class FPrimitiveSceneProxy;
class FSimpleElementCollector;
struct FMeshBatchAndRelevance;
 
 
namespace RuntimeVirtualTexture { class FDynamicMeshCollector; }
 
class FMeshElementCollector
{
public:
 
    ENGINE_API FPrimitiveDrawInterface* GetPDI(int32 ViewIndex);
 
#if UE_ENABLE_DEBUG_DRAWING
    ENGINE_API FPrimitiveDrawInterface* GetDebugPDI(int32 ViewIndex);
#endif
 
    inline FMeshBatch& AllocateMesh()
    {
        const int32 Index = MeshBatchStorage.Add(1);
        return MeshBatchStorage[Index];
    }
 
    FGlobalDynamicIndexBuffer& GetDynamicIndexBuffer()
    {
        check(DynamicIndexBuffer);
        return *DynamicIndexBuffer;
    }
 
    FGlobalDynamicVertexBuffer& GetDynamicVertexBuffer()
    {
        check(DynamicVertexBuffer);
        return *DynamicVertexBuffer;
    }
 
    FGlobalDynamicReadBuffer& GetDynamicReadBuffer()
    {
        check(DynamicReadBuffer);
        return *DynamicReadBuffer;
    }
 
    FRHICommandList& GetRHICommandList()
    {
        check(RHICmdList);
        return *RHICmdList;
    }
 
    // @return number of MeshBatches collected (so far) for a given view
    uint32 GetMeshBatchCount(uint32 ViewIndex) const
    {
        return MeshBatches[ViewIndex]->Num();
    }
 
    // @return Number of elemenets collected so far for a given view.
    uint32 GetMeshElementCount(uint32 ViewIndex) const
    {
        return NumMeshBatchElementsPerView[ViewIndex];
    }
 
    ENGINE_API void AddMesh(int32 ViewIndex, FMeshBatch& MeshBatch);
 
    ENGINE_API void RegisterOneFrameMaterialProxy(FMaterialRenderProxy* Proxy);
 
    ENGINE_API void CacheUniformExpressions(FMaterialRenderProxy* Proxy, bool bRecreateUniformBuffer);
 
    template<typename T, typename... ARGS>
    T& AllocateOneFrameResource(ARGS&&... Args)
    {
        return *OneFrameResources.Create<T>(Forward<ARGS>(Args)...);
    }
    
    UE_DEPRECATED(5.3, "ShouldUseTasks has been deprecated.")
    inline bool ShouldUseTasks() const
    {
        return false;
    }
    
    UE_DEPRECATED(5.3, "AddTask has been deprecated.")
    inline void AddTask(TFunction<void()>&& Task) {}
 
    UE_DEPRECATED(5.3, "AddTask has been deprecated.")
    inline void AddTask(const TFunction<void()>& Task) {}
 
    UE_DEPRECATED(5.3, "ProcessTasks has been deprecated.")
    void ProcessTasks() {}
 
    inline ERHIFeatureLevel::Type GetFeatureLevel() const
    {
        return FeatureLevel;
    }
 
protected:
    enum class ECommitFlags
    {
        None = 0,
 
        // Defers material uniform expression updates until Commit or Finish is called.
        DeferMaterials = 1 << 0,
 
        // Defers GPU scene updates until Commit or Finish is called.
        DeferGPUScene  = 1 << 1,
 
        DeferAll = DeferMaterials | DeferGPUScene
    };
    FRIEND_ENUM_CLASS_FLAGS(ECommitFlags);
 
    ENGINE_API FMeshElementCollector(ERHIFeatureLevel::Type InFeatureLevel, FSceneRenderingBulkObjectAllocator& InBulkAllocator, ECommitFlags CommitFlags = ECommitFlags::None);
 
    ENGINE_API ~FMeshElementCollector();
 
    ENGINE_API void SetPrimitive(const FPrimitiveSceneProxy* InPrimitiveSceneProxy, const FHitProxyId& DefaultHitProxyId);
 
    ENGINE_API void Start(
        FRHICommandList& RHICmdList,
        FGlobalDynamicVertexBuffer& DynamicVertexBuffer,
        FGlobalDynamicIndexBuffer& DynamicIndexBuffer,
        FGlobalDynamicReadBuffer& DynamicReadBuffer);
 
    ENGINE_API void AddViewMeshArrays(
        const FSceneView* InView,
        TArray<FMeshBatchAndRelevance, SceneRenderingAllocator>* ViewMeshes,
        FSimpleElementCollector* ViewSimpleElementCollector,
        FGPUScenePrimitiveCollector* DynamicPrimitiveCollector
#if UE_ENABLE_DEBUG_DRAWING
        , FSimpleElementCollector* DebugSimpleElementCollector = nullptr
#endif
        );
 
    ENGINE_API void ClearViewMeshArrays();
 
    ENGINE_API void Commit();
 
    ENGINE_API void Finish();
 
    TChunkedArray<FMeshBatch, 16384, FConcurrentLinearArrayAllocator> MeshBatchStorage;
 
    TArray<TArray<FMeshBatchAndRelevance, SceneRenderingAllocator>*, TInlineAllocator<2, SceneRenderingAllocator> > MeshBatches;
 
    TArray<int32, TInlineAllocator<2, SceneRenderingAllocator> > NumMeshBatchElementsPerView;
 
    TArray<FSimpleElementCollector*, TInlineAllocator<2, SceneRenderingAllocator> > SimpleElementCollectors;
 
#if UE_ENABLE_DEBUG_DRAWING
    TArray<FSimpleElementCollector*, TInlineAllocator<2, SceneRenderingAllocator> > DebugSimpleElementCollectors;
#endif
 
    TArray<const FSceneView*, TInlineAllocator<2, SceneRenderingAllocator>> Views;
 
    TArray<uint16, TInlineAllocator<2, SceneRenderingAllocator>> MeshIdInPrimitivePerView;
 
    TArray<FMaterialRenderProxy*, SceneRenderingAllocator> MaterialProxiesToDelete;
 
    TArray<TPair<FMaterialRenderProxy*, bool>, SceneRenderingAllocator> MaterialProxiesToInvalidate;
 
    TArray<const FMaterialRenderProxy*, SceneRenderingAllocator> MaterialProxiesToUpdate;
 
    TArray<TPair<FGPUScenePrimitiveCollector*, FMeshBatch*>, SceneRenderingAllocator> MeshBatchesForGPUScene;
 
    FSceneRenderingBulkObjectAllocator& OneFrameResources;
 
    const FPrimitiveSceneProxy* PrimitiveSceneProxy;
 
    FGlobalDynamicIndexBuffer* DynamicIndexBuffer = nullptr;
    FGlobalDynamicVertexBuffer* DynamicVertexBuffer = nullptr;
    FGlobalDynamicReadBuffer* DynamicReadBuffer = nullptr;
 
    FRHICommandList* RHICmdList = nullptr;
 
    const ERHIFeatureLevel::Type FeatureLevel;
    const ECommitFlags CommitFlags;
    const bool bUseGPUScene;
 
    TArray<FGPUScenePrimitiveCollector*, TInlineAllocator<2, SceneRenderingAllocator>> DynamicPrimitiveCollectorPerView;
 
    friend class FVisibilityTaskData;
    friend class FSceneRenderer;
    friend class FDeferredShadingSceneRenderer;
    friend class FProjectedShadowInfo;
    friend class FCardPageRenderData;
    friend class FViewFamilyInfo;
    friend class FShadowMeshCollector;
    friend class FDynamicMeshElementContext;
    friend class RuntimeVirtualTexture::FDynamicMeshCollector;
    friend FSceneRenderingBulkObjectAllocator;
};
 
ENUM_CLASS_FLAGS(FMeshElementCollector::ECommitFlags);