PSOPrecacheMaterial.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    PSOPrecacheMaterial.h
=============================================================================*/
 
#pragma once
 
#include "PSOPrecache.h"
#include "SceneUtils.h"
 
struct FSceneTexturesConfig;
class FRHIComputeShader;
class FMaterial;
class FVertexFactoryType;
class FGraphicsPipelineStateInitializer;
enum class EVertexInputStreamType : uint8;
 
 
class IPSOCollector
{
public:
 
    IPSOCollector(int32 InPSOCollectorIndex) : PSOCollectorIndex(InPSOCollectorIndex) {}
    virtual ~IPSOCollector() {}
 
    UE_DEPRECATED(5.2, "Call CollectPSOInitializers with FPSOPrecacheVertexFactoryData instead.")
    void CollectPSOInitializers(const FSceneTexturesConfig& SceneTexturesConfig, const FMaterial& Material, const FVertexFactoryType* VertexFactoryType, const FPSOPrecacheParams& PreCacheParams, TArray<FPSOPrecacheData>& PSOInitializers)
    {
        FPSOPrecacheVertexFactoryData VertexFactoryData;
        VertexFactoryData.VertexFactoryType = VertexFactoryType;
        return CollectPSOInitializers(SceneTexturesConfig, Material, VertexFactoryData, PreCacheParams, PSOInitializers);
    }
 
    // Collect all PSO for given material, vertex factory & params
    virtual void CollectPSOInitializers(const FSceneTexturesConfig& SceneTexturesConfig, const FMaterial& Material, const FPSOPrecacheVertexFactoryData& VertexFactoryData, const FPSOPrecacheParams& PreCacheParams, TArray<FPSOPrecacheData>& PSOInitializers) = 0;
 
    // PSO Collector index used for stats tracking
    int32 PSOCollectorIndex = INDEX_NONE;
};
 
typedef IPSOCollector* (*PSOCollectorCreateFunction)(ERHIFeatureLevel::Type InFeatureLevel);
 
class FPSOCollectorCreateManager
{
public:
    constexpr static uint32 MaxPSOCollectorCount = 64;
 
    static int32 GetPSOCollectorCount(EShadingPath ShadingPath) { return PSOCollectorCount[(uint32)ShadingPath]; }
    static PSOCollectorCreateFunction GetCreateFunction(EShadingPath ShadingPath, int32 Index)
    {
        check(Index < MaxPSOCollectorCount);
        uint32 ShadingPathIdx = (uint32)ShadingPath;
        return PSOCollectors[ShadingPathIdx][Index].CreateFunction;
    }
    static const TCHAR* GetName(EShadingPath ShadingPath, int32 Index)
    {
        if (Index == INDEX_NONE)
        {
            return TEXT("Unknown");
        }
        check(Index < MaxPSOCollectorCount);
        uint32 ShadingPathIdx = (uint32)ShadingPath;
        return PSOCollectors[ShadingPathIdx][Index].Name;
    }
    static ENGINE_API int32 GetIndex(EShadingPath ShadingPath, const TCHAR* Name);
 
private:
 
    // Have to used fixed size array instead of TArray because of order of initialization of static member variables
    static inline int32 PSOCollectorCount[(uint32)EShadingPath::Num] = {0,0};
 
    struct FPSOCollectorData
    {
        PSOCollectorCreateFunction CreateFunction;
        const TCHAR* Name = nullptr;
    };
    static ENGINE_API FPSOCollectorData PSOCollectors[(uint32)EShadingPath::Num][MaxPSOCollectorCount];
 
    friend class FRegisterPSOCollectorCreateFunction;
};
 
class FRegisterPSOCollectorCreateFunction
{
public:
    FRegisterPSOCollectorCreateFunction(PSOCollectorCreateFunction InCreateFunction, EShadingPath InShadingPath, const TCHAR* InName)
        : ShadingPath(InShadingPath)
    {
        uint32 ShadingPathIdx = (uint32)ShadingPath;
 
        Index = FPSOCollectorCreateManager::PSOCollectorCount[ShadingPathIdx];
        check(Index < FPSOCollectorCreateManager::MaxPSOCollectorCount);
 
        FPSOCollectorCreateManager::PSOCollectors[ShadingPathIdx][Index].CreateFunction = InCreateFunction;
        FPSOCollectorCreateManager::PSOCollectors[ShadingPathIdx][Index].Name = InName;
        FPSOCollectorCreateManager::PSOCollectorCount[ShadingPathIdx]++;
    }
 
    ~FRegisterPSOCollectorCreateFunction()
    {
        uint32 ShadingPathIdx = (uint32)ShadingPath;
        FPSOCollectorCreateManager::PSOCollectors[ShadingPathIdx][Index].CreateFunction = nullptr;
        FPSOCollectorCreateManager::PSOCollectors[ShadingPathIdx][Index].Name = nullptr;
    }
 
    int32 GetIndex() const { return Index; }
 
private:
    EShadingPath ShadingPath;
    uint32 Index;
};
 
extern ENGINE_API void PrecacheMaterialPSOs(const FMaterialInterfacePSOPrecacheParamsList& PSOPrecacheParamsList, TArray<FMaterialPSOPrecacheRequestID>& OutMaterialPSOPrecacheRequestIDs, FGraphEventArray& OutGraphEvents);
 
extern ENGINE_API FMaterialPSOPrecacheRequestID PrecacheMaterialPSOs(const FMaterialPSOPrecacheParams& MaterialPSOPrecacheParams, EPSOPrecachePriority Priority, FGraphEventArray& GraphEvents);
 
extern ENGINE_API void PreloadMaterialShaderMap(const FMaterial* Material, FGraphEventArray& OutGraphEvents);
 
extern ENGINE_API void ReleasePSOPrecacheData(const TArray<FMaterialPSOPrecacheRequestID>& MaterialPSORequestIDs);
 
extern ENGINE_API void BoostPSOPriority(EPSOPrecachePriority NewPri, const TArray<FMaterialPSOPrecacheRequestID>& MaterialPSORequestIDs);
 
extern ENGINE_API void ClearMaterialPSORequests();
 
extern ENGINE_API FMaterialPSOPrecacheParams GetMaterialPSOPrecacheParams(FMaterialPSOPrecacheRequestID RequestID);
 
extern ENGINE_API FPSOPrecacheDataArray GetMaterialPSOPrecacheData(FMaterialPSOPrecacheRequestID RequestID);