PipelineCacheUtilities.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/Build.h"
 
// cooked games may want to load key files for extra information about the PSOs
#define UE_WITH_PIPELINE_CACHE_UTILITIES            (WITH_EDITOR || !UE_BUILD_SHIPPING)
#if UE_WITH_PIPELINE_CACHE_UTILITIES
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "RHIDefinitions.h"
#include "ShaderCodeLibrary.h"
 
class FName;
class FSHAHash;
class ITargetPlatform;
struct FPipelineCacheFileFormatPSO;
struct FStableShaderKeyAndValue;
 
namespace UE
{
namespace PipelineCacheUtilities
{
#if WITH_EDITOR // limit what's compiled for the cooked games
 
    struct FPermutation
    {
        int32 Slots[SF_NumFrequencies];
    };
 
    struct FPermsPerPSO
    {
        const FPipelineCacheFileFormatPSO* PSO;
        bool ActivePerSlot[SF_NumFrequencies];
        TArray<FPermutation> Permutations;
 
        FPermsPerPSO()
            : PSO(nullptr)
        {
            for (int32 Index = 0; Index < SF_NumFrequencies; Index++)
            {
                ActivePerSlot[Index] = false;
            }
        }
    };
 
#endif // WITH_EDITOR
 
    RENDERCORE_API bool LoadStableKeysFile(const FStringView& Filename, TArray<FStableShaderKeyAndValue>& InOutArray);
 
#if WITH_EDITOR // limit what's compiled for the cooked games
 
    RENDERCORE_API bool SaveStableKeysFile(const FStringView& Filename, const FStableShaderSet& Values);
 
    RENDERCORE_API bool SaveStablePipelineCacheFile(const FString& OutputFilename, const TArray<FPermsPerPSO>& StableResults, const TArray<FStableShaderKeyAndValue>& StableShaderKeyIndexTable);
 
    RENDERCORE_API bool LoadStablePipelineCacheFile(const FString& Filename, const FStableShaderSet& StableMap, TSet<FPipelineCacheFileFormatPSO>& OutPSOs, FName& OutTargetPlatform, int32& OutPSOsRejected, int32& OutPSOsMerged);
 
    RENDERCORE_API bool SaveChunkInfo(const FString& ShaderLibraryName, const int32 InChunkId, const TSet<FName>& InPackagesInChunk, const ITargetPlatform* TargetPlatform, const FString& PathToSaveTo, TArray<FString>& OutChunkFilenames);
 
    RENDERCORE_API void FindAllChunkInfos(const FString& ShaderLibraryName, const FString& TargetPlatformName, const FString& PathToSearchIn, TArray<FString>& OutInfoFilenames);
 
    RENDERCORE_API bool LoadChunkInfo(const FString& Filename, const FString& InShaderFormat, int32 &OutChunkId, FString& OutChunkedCacheFilename, TSet<FName>& OutPackages);
 
#endif // WITH_EDITOR
 
}
};
 
#endif // UE_WITH_PIPELINE_CACHE_UTILITIES