Navigation
API > API/Runtime > API/Runtime/Engine
Shader compiling thread This runs in the background while UE is running, launches shader compile worker processes when necessary, and feeds them inputs and reads back the outputs.
| Name | FShaderCompileThreadRunnable |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/ShaderCompiler.h |
| Include Path | #include "ShaderCompiler.h" |
Syntax
class FShaderCompileThreadRunnable : public FShaderCompileThreadRunnableBase
Inheritance Hierarchy
- FRunnable → FShaderCompileThreadRunnableBase → FShaderCompileThreadRunnable
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FShaderCompileThreadRunnable
(
FShaderCompilingManager* InManager |
Initialization constructor. | ShaderCompiler.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FShaderCompileThreadRunnable() |
ShaderCompiler.h |
Structs
| Name | Remarks |
|---|---|
| FMemoryMonitoringState |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackloggedJobs | TArray< FShaderCommonCompileJobPtr > | List of jobs that have been backlogged when workers had to be closed due to reaching memory limits. | ShaderCompiler.h | |
| bEstimateCommittedMemory | const bool | ShaderCompiler.h | ||
| bParallelizeIO | bool | Whether to read/write files for SCW in parallel (can help situations when this takes too long for a number of reasons) | ShaderCompiler.h | |
| LastCheckForWorkersTime | double | Tracks the last time that this thread checked if the workers were still active. | ShaderCompiler.h | |
| MemoryMonitoringState | FShaderCompileThreadRunnable::FMemoryMonitoringState | ShaderCompiler.h | ||
| WorkerInfos | TArray< TUniquePtr< struct FShaderCompileWorkerInfo > > | Information about the active workers that this thread is tracking. | ShaderCompiler.h | |
| WorkerInfosLock | FCriticalSection | ShaderCompiler.h |
Functions
Public
Overridden from FShaderCompileThreadRunnableBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EShaderCompilerWorkerType GetWorkerType() |
Returns the type of shader workers this thread represents. | ShaderCompiler.h |
Protected
Overridden from FShaderCompileThreadRunnableBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FShaderCompileMemoryUsage GetExternalWorkerMemoryUsage() |
Returns the amount of memory (in bytes) used by external processes related to this, if any. | ShaderCompiler.h | |
virtual bool PrintWorkerMemoryUsage
(
bool bAllowToWaitForLock |
Tries to print out the memory usage of all shader compile workers. | ShaderCompiler.h |