1. Epic GamesDeveloper
  3. FShaderLibraryCooker

FShaderLibraryCooker

API > API/Runtime > API/Runtime/RenderCore

   
Name FShaderLibraryCooker
Type struct
Header File /Engine/Source/Runtime/RenderCore/Public/ShaderCodeLibrary.h
Include Path #include "ShaderCodeLibrary.h"

Syntax

struct FShaderLibraryCooker

Structs

Name Remarks
FShaderFormatDescriptor  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddShaderCode ( EShaderPlatform ShaderPlatform,
const FShaderMapResourceCode* Code,
const FShaderMapAssetPaths& AssociatedAssets
)

 At cook time, add shader code to collection. ShaderCodeLibrary.h  

static void AddShaderStableKeyValue ( EShaderPlatform ShaderPlatform,
FStableShaderKeyAndValue& StableKeyValue
)

 At cook time, add the human readable key value information. ShaderCodeLibrary.h  

static bool AppendFromCompactBinary ( FCbFieldView Field
)

 Called On the CookDirector to receive ShaderLibrary contents from a CookWorker ShaderCodeLibrary.h  

static bool BeginCookingLibrary ( FString const& Name
)

 Opens a named library for cooking and sets it as the default. ShaderCodeLibrary.h  

static void CleanDirectories ( TArray< FName > const& ShaderFormats
)

 Clean the cook directories. ShaderCodeLibrary.h  

static void CookShaderFormats ( TArray< FShaderFormatDescriptor > const& ShaderFormats
)

 Specify the shader formats to cook and which ones needs stable keys. Provide an array of FShaderFormatDescriptors. ShaderCodeLibrary.h  

static void CopyToCompactBinaryAndClear ( FCbWriter& Writer,
bool& bOutHasData,
bool& bOutRanOutOfRoom,
int64 MaxShaderSize
)

 Called from a CookWorker to send all contents of the ShaderLibrary to the CookDirector ShaderCodeLibrary.h  

static bool CreatePatchLibrary ( TArray< FString > const& OldMetaDataDirs,
FString const& NewMetaDataDir,
FString const& OutDir,
bool bNativeFormat,
bool bNeedsDeterministicOrder
)

 Create a smaller 'patch' library that only contains data from 'NewMetaDataDir' not contained in any of 'OldMetaDataDirs'. ShaderCodeLibrary.h  

static void DumpShaderCodeStats()

 Dump collected stats for each shader platform ShaderCodeLibrary.h  

static void DumpShaderTypeStats ( const FString& DebugInfoPath,
const FString& MetaDataPath
)

   ShaderCodeLibrary.h  

static void EndCookingLibrary ( FString const& Name
)

 Close a named library. ShaderCodeLibrary.h  

static void FinishPopulateShaderLibrary ( const ITargetPlatform* TargetPlatform,
FString const& Name,
FString const& SandboxDestinationPath,
FString const& SandboxMetadataPath
)

 Finishes collection of data that should be in the named code library. ShaderCodeLibrary.h  

static void InitForCooking ( bool bNativeFormat,
ICookArtifactReader* CookArtifactReader
)

 Initialize the library cooker. ShaderCodeLibrary.h  

static bool IsShaderLibraryEnabled()

 Whether storing shaders in the shader library is enabled ShaderCodeLibrary.h  

static bool MergeShaderCodeArchive ( const TArray< FString >& CookedMetadataDirs,
const FString& OutputDir,
TArray< FString >& OutWrittenFiles
)

 Given multiple Cooked Metadata directories will attempt to merge the ShaderByteCode and the ShaderStableInfo into the given OutputDir. ShaderCodeLibrary.h  

static bool NeedsShaderStableKeys ( EShaderPlatform ShaderPlatform
)

 We check this early in the callstack to avoid creating a bunch of FName and keys and things we will never save anyway. ShaderCodeLibrary.h  

static bool SaveShaderLibraryChunk ( int32 ChunkId,
const TSet< FName >& InPackagesInChunk,
const ITargetPlatform* TargetPlatform,
const FString& SandboxDestinationPath,
const FString& SandboxMetadataPath,
TArray< FString >& OutChunkFilenames,
bool& bOutHasData
)

 Saves a single chunk of the collected shader code (per shader platform). ShaderCodeLibrary.h  

static bool SaveShaderLibraryWithoutChunking ( const ITargetPlatform* TargetPlatform,
FString const& Name,
FString const& SandboxDestinationPath,
FString const& SandboxMetadataPath,
TArray< FString >& PlatformSCLCSVPaths,
FString& OutErrorMessage,
bool& bOutHasData
)

 Saves collected shader code to a single file per shader platform When chunking is enabled, this call will not write the shader code, only the SCL.CSV file with the stable shader info. ShaderCodeLibrary.h  

static void Shutdown()

 Shutdown the library cooker. ShaderCodeLibrary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page