1. Epic GamesDeveloper
  3. FShaderCompilerStats

FShaderCompilerStats

API > API/Runtime > API/Runtime/Engine

   
Name FShaderCompilerStats
Type struct
Header File /Engine/Source/Runtime/Engine/Public/ShaderCompiler.h
Include Path #include "ShaderCompiler.h"

Syntax

struct FShaderCompilerStats

Structs

Name Remarks
FWorkerDiagnosticsInfo  

Enums

Public

Name Remarks
EExecutionType  

Typedefs

Name Type Remarks Include Path
ShaderCompilerStats TMap< FString, FShaderStats >   ShaderCompiler.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bMultiProcessAggregated bool   ShaderCompiler.h  
CompileStats TSparseArray< ShaderCompilerStats >   ShaderCompiler.h  
CompileStatsLock FCriticalSection   ShaderCompiler.h  
Counters FShaderCompilerCounters   ShaderCompiler.h  
JobLifeTimeIntervals TArray< TInterval< double > > Accumulates the job lifetimes without overlaps ShaderCompiler.h  
MaterialCounters FShaderCompilerMaterialCounters   ShaderCompiler.h  
ShaderTimings TMap< FString, FShaderTimings > Map of shader names to their compilation timings ShaderCompiler.h  
WorkerDiagnostics TArray< FWorkerDiagnosticsInfo > Array of diagnostics information per batch. ShaderCompiler.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddDDCHit ( uint32 NumHits
)

   ShaderCompiler.h  

void AddDDCMiss ( uint32 NumMisses
)

   ShaderCompiler.h  

void Aggregate ( FShaderCompilerStats& Other
)

   ShaderCompiler.h  

void GatherAnalytics ( const FString& BaseName,
TArray< FAnalyticsEventAttribute >& Attributes
)

   ShaderCompiler.h  

uint32 GetDDCHits()

   ShaderCompiler.h  

uint32 GetDDCMisses()

   ShaderCompiler.h  

const TSparseArray< ShaderCompilerStats > & GetShaderCompilerStats()

   ShaderCompiler.h  

double GetTimeShaderCompilationWasActive()

   ShaderCompiler.h  

uint32 GetTotalShadersCompiled()

   ShaderCompiler.h  

void IncrementMaterialCacheHit()

   ShaderCompiler.h  

void IncrementMaterialCook()

   ShaderCompiler.h  

void IncrementMaterialTranslated ( double InTotalTime,
double InTranslationOnlyTime,
double InSerializeTime
)

   ShaderCompiler.h  

void ReadFromCompactBinary ( FCbObjectView& Reader
)

   ShaderCompiler.h  
Marks the job as given out to a worker for execution for the stats purpose. ShaderCompiler.h  

void RegisterCompiledShaders ( uint32 NumPermutations,
EShaderPlatform Platform,
const FString MaterialPath,
FString PermutationString
)

   ShaderCompiler.h  

void RegisterCookedShaders ( uint32 NumCooked,
float CompileTime,
EShaderPlatform Platform,
const FString MaterialPath,
FString PermutationString
)

   ShaderCompiler.h  

void RegisterDistributedBuildStats ( const FDistributedBuildStats& InStats
)

 Informs about current distributed build statistics. ShaderCompiler.h  

void RegisterFinishedJob ( FShaderCommonCompileJob& InOutJob,
bool bCompilationSkipped
)

 Marks the job as finished for the stats purpose. ShaderCompiler.h  

void RegisterJobBatch ( int32 NumJobs,
EExecutionType ExecType
)

 Informs statistics about a new job batch, so we can tally up batches. ShaderCompiler.h  

void RegisterLocalWorkerIdleTime ( double IdleTime
)

 Informs statistics about a time a local ShaderCompileWorker spent idle. ShaderCompiler.h  
Lets the stats to know about a newly added job. ShaderCompiler.h  

void RegisterWorkerDiagnostics ( const FShaderCompileWorkerDiagnostics& InDiagnostics,
FString&& InBatchLabel,
int32 InBatchSize,
uint32 InWorkerId
)

 Informs statistics about a new worker diagnostics for a finished job batch. ShaderCompiler.h  

void SetMultiProcessAggregated()

   ShaderCompiler.h  

TSharedPtr< FJsonObject > ToJson()

   ShaderCompiler.h  

void WriteStats ( FOutputDevice* Ar
)

   ShaderCompiler.h  

void WriteStatSummary()

   ShaderCompiler.h  

void WriteToCompactBinary ( FCbWriter& Writer
)

   ShaderCompiler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page