1. Epic GamesDeveloper
  3. FShaderLibraryCooker

FShaderLibraryCooker

API > API/Runtime > API/Runtime/RenderCore

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/ShaderCodeLibrary.h
Include #include "ShaderCodeLibrary.h"

Syntax

struct FShaderLibraryCooker

Functions

  Type Name Description
Public function Static bool

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

 At cook time, add shader code to collection.
Public function Static void

AddShaderStableKeyValue ( EShaderPlatform ShaderPlatform,
FStableShaderKeyAndValue& StableKeyValue
)

 At cook time, add the human readable key value information.
Public function Static bool Called On the CookDirector to receive ShaderLibrary contents from a CookWorker
Public function Static bool

BeginCookingLibrary ( FString const& Name
)

 Opens a named library for cooking and sets it as the default.
Public function Static void

CleanDirectories ( TArray< FName > const& ShaderFormats
)

 Clean the cook directories.
Public function Static void

CookShaderFormats ( TArray< FShaderFormatDescriptor > const& ShaderFormats
)

 Specify the shader formats to cook and which ones needs stable keys. Provide an array of FShaderFormatDescriptors.
Public function 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
Public function 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'.
Public function Static void Dump collected stats for each shader platform.
Public function Static void

EndCookingLibrary ( FString const& Name
)

 Close a named library.
Public function 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.
Public function Static void

InitForCooking ( bool bNativeFormat
)

 Initialize the library cooker.
Public function Static bool Whether storing shaders in the shader library is enabled
Public function 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.
Public function 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).
Public function 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.
Public function Static void Shutdown the library cooker.

Classes

  Type Name Description
Public struct FShaderFormatDescriptor    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page