UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FShaderCompileWorkerInfo Struct Reference

Public Member Functions

 FShaderCompileWorkerInfo ()
 
 ~FShaderCompileWorkerInfo ()
 
void TerminateWorkerProcess (bool bAsynchronous=false)
 
int32 CloseWorkerProcess ()
 

Public Attributes

FProcHandle WorkerProcess
 
uint32 WorkerProcessId
 
bool bIssuedTasksToWorker
 
bool bLaunchedWorker
 
bool bComplete
 
bool bAvailable
 
double StartTime
 
double FinishTime
 
TArray< FShaderCommonCompileJobPtrQueuedJobs
 
uint64 QueuedBatchId
 

Detailed Description

Information tracked for each shader compile worker process instance.

Constructor & Destructor Documentation

◆ FShaderCompileWorkerInfo()

FShaderCompileWorkerInfo::FShaderCompileWorkerInfo ( )
inline

◆ ~FShaderCompileWorkerInfo()

FShaderCompileWorkerInfo::~FShaderCompileWorkerInfo ( )
inline

Member Function Documentation

◆ CloseWorkerProcess()

int32 FShaderCompileWorkerInfo::CloseWorkerProcess ( )
inline

◆ TerminateWorkerProcess()

void FShaderCompileWorkerInfo::TerminateWorkerProcess ( bool  bAsynchronous = false)
inline

Member Data Documentation

◆ bAvailable

bool FShaderCompileWorkerInfo::bAvailable

Whether this worker is available for new jobs. It will be false when shutting down the worker.

◆ bComplete

bool FShaderCompileWorkerInfo::bComplete

Tracks whether all tasks issued to the worker have been received.

◆ bIssuedTasksToWorker

bool FShaderCompileWorkerInfo::bIssuedTasksToWorker

Tracks whether tasks have been issued to the worker.

◆ bLaunchedWorker

bool FShaderCompileWorkerInfo::bLaunchedWorker

Whether the worker has been launched for this set of tasks.

◆ FinishTime

double FShaderCompileWorkerInfo::FinishTime

Time at which the worker ended the most recent batch of tasks.

◆ QueuedBatchId

uint64 FShaderCompileWorkerInfo::QueuedBatchId

Current batch ID to uniquely identify each batch for diagnostics output.

◆ QueuedJobs

TArray<FShaderCommonCompileJobPtr> FShaderCompileWorkerInfo::QueuedJobs

Jobs that this worker is responsible for compiling.

◆ StartTime

double FShaderCompileWorkerInfo::StartTime

Time at which the worker started the most recent batch of tasks.

◆ WorkerProcess

FProcHandle FShaderCompileWorkerInfo::WorkerProcess

Process handle of the worker app once launched. Invalid handle means no process.

◆ WorkerProcessId

uint32 FShaderCompileWorkerInfo::WorkerProcessId

Process ID of the worker app once launched. Zero means no process.


The documentation for this struct was generated from the following file: