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

#include <ShaderCompilerJobTypes.h>

Public Member Functions

void Clear ()
 

Public Attributes

struct FShaderJobDataBlockBlock = nullptr
 
int32 IndexInBlock = INDEX_NONE
 
int32 DuplicateIndex = INDEX_NONE
 

Detailed Description

Cached reference to the location of an in-flight job's FShaderJobData in the FShaderJobDataMap, used by the private FShaderJobCache class.

Caching the reference avoids the need to do additional map lookups to find the entry again, potentially avoiding a lock of the container for the lookup. Heap allocation of blocks is used by the cache to allow map entries to have a persistent location in memory. The persistent memory allows modifications of map entry data for a given job, without needing locks to protect against container resizing.

In-flight jobs and their duplicates reference the same FShaderJobData. Client code should treat this structure as opaque.

Member Function Documentation

◆ Clear()

void FShaderJobCacheRef::Clear ( )
inline

Member Data Documentation

◆ Block

struct FShaderJobDataBlock* FShaderJobCacheRef::Block = nullptr

Pointer to block the private FShaderJobData is stored in

◆ DuplicateIndex

int32 FShaderJobCacheRef::DuplicateIndex = INDEX_NONE

If job is a duplicate, index of pointer to job in DuplicateJobs array in FShaderJobCache, used for clearing the pointer when the in-flight job completes

◆ IndexInBlock

int32 FShaderJobCacheRef::IndexInBlock = INDEX_NONE

Index of FShaderJobData in the block


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