UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ShaderPipelineCache.cpp File Reference

Classes

class  FShaderPipelineCacheArchive
 
class  FShaderPipelineCacheTask
 

Namespaces

namespace  FShaderPipelineCacheConstants
 
namespace  UE
 
namespace  UE::ShaderPipeline
 

Functions

 DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Outstanding Tasks"), STAT_ShaderPipelineTaskCount, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Waiting Tasks"), STAT_ShaderPipelineWaitingTaskCount, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Active Tasks"), STAT_ShaderPipelineActiveTaskCount, STATGROUP_PipelineStateCache)
 
 DECLARE_MEMORY_STAT (TEXT("Pre-Compile Memory"), STAT_PreCompileMemory, STATGROUP_PipelineStateCache)
 
 DECLARE_CYCLE_STAT (TEXT("Pre-Compile Time"), STAT_PreCompileTime, STATGROUP_PipelineStateCache)
 
 DECLARE_FLOAT_ACCUMULATOR_STAT (TEXT("Total Pre-Compile Time"), STAT_PreCompileTotalTime, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Total Pipelines Pre-Compiled"), STAT_PreCompileShadersTotal, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_COUNTER_STAT (TEXT("# Pipelines Pre-Compiled"), STAT_PreCompileShadersNum, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Total Batches Pre-Compiled"), STAT_PreCompileBatchTotal, STATGROUP_PipelineStateCache)
 
 DECLARE_DWORD_COUNTER_STAT (TEXT("# Batches Pre-Compiled"), STAT_PreCompileBatchNum, STATGROUP_PipelineStateCache)
 
void ConsoleCommandLoadPipelineFileCache ()
 
void ConsoleCommandClosePipelineFileCache ()
 
void ConsoleCommandSavePipelineFileCache ()
 
void ConsoleCommandSwitchModePipelineCacheCmd (const TArray< FString > &Args)
 

Variables

int32 GShaderPipelineCacheDoNotPrecompileComputePSO = PLATFORM_ANDROID
 
bool GShaderPipelineCacheDoNotPrecompileRayTracingPSO = false
 

Function Documentation

◆ ConsoleCommandClosePipelineFileCache()

void ConsoleCommandClosePipelineFileCache ( )

◆ ConsoleCommandLoadPipelineFileCache()

void ConsoleCommandLoadPipelineFileCache ( )

◆ ConsoleCommandSavePipelineFileCache()

void ConsoleCommandSavePipelineFileCache ( )

◆ ConsoleCommandSwitchModePipelineCacheCmd()

void ConsoleCommandSwitchModePipelineCacheCmd ( const TArray< FString > &  Args)

◆ DECLARE_CYCLE_STAT()

DECLARE_CYCLE_STAT ( TEXT("Pre-Compile Time" ,
STAT_PreCompileTime  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT() [1/5]

DECLARE_DWORD_ACCUMULATOR_STAT ( TEXT("Active Tasks" ,
STAT_ShaderPipelineActiveTaskCount  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT() [2/5]

DECLARE_DWORD_ACCUMULATOR_STAT ( TEXT("Outstanding Tasks" ,
STAT_ShaderPipelineTaskCount  ,
STATGROUP_PipelineStateCache   
)

Shader Pipeline Precompilation Cache Precompilation half of the shader pipeline cache, which builds on the runtime RHI pipeline cache.

◆ DECLARE_DWORD_ACCUMULATOR_STAT() [3/5]

DECLARE_DWORD_ACCUMULATOR_STAT ( TEXT("Total Batches Pre-Compiled" ,
STAT_PreCompileBatchTotal  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT() [4/5]

DECLARE_DWORD_ACCUMULATOR_STAT ( TEXT("Total Pipelines Pre-Compiled" ,
STAT_PreCompileShadersTotal  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT() [5/5]

DECLARE_DWORD_ACCUMULATOR_STAT ( TEXT("Waiting Tasks" ,
STAT_ShaderPipelineWaitingTaskCount  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_COUNTER_STAT() [1/2]

DECLARE_DWORD_COUNTER_STAT ( TEXT("# Batches Pre-Compiled" ,
STAT_PreCompileBatchNum  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_DWORD_COUNTER_STAT() [2/2]

DECLARE_DWORD_COUNTER_STAT ( TEXT("# Pipelines Pre-Compiled" ,
STAT_PreCompileShadersNum  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_FLOAT_ACCUMULATOR_STAT()

DECLARE_FLOAT_ACCUMULATOR_STAT ( TEXT("Total Pre-Compile Time" ,
STAT_PreCompileTotalTime  ,
STATGROUP_PipelineStateCache   
)

◆ DECLARE_MEMORY_STAT()

DECLARE_MEMORY_STAT ( TEXT("Pre-Compile Memory" ,
STAT_PreCompileMemory  ,
STATGROUP_PipelineStateCache   
)

Variable Documentation

◆ GShaderPipelineCacheDoNotPrecompileComputePSO

int32 GShaderPipelineCacheDoNotPrecompileComputePSO = PLATFORM_ANDROID

◆ GShaderPipelineCacheDoNotPrecompileRayTracingPSO

bool GShaderPipelineCacheDoNotPrecompileRayTracingPSO = false