UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState > Class Template Reference

Classes

struct  FPrecacheTask
 

Public Member Functions

 TPrecachePipelineCacheBase (FPSOPrecacheRequestID::EType InType, uint32 InMaxInMemoryPSOs)
 
 ~TPrecachePipelineCacheBase ()
 
void SetMaxInMemoryPSOs (uint32 NewMaxInMemoryPSOs)
 
void WaitTasksComplete ()
 
EPSOPrecacheResult GetPrecachingState (const FPSOPrecacheRequestID &RequestID)
 
EPSOPrecacheResult GetPrecachingState (const TPrecachedPSOInitializer &Initializer)
 
EPSOPrecacheResult GetPrecachingStateAndMarkUsed (const TPrecachedPSOInitializer &Initializer, bool &bOutMarkedUsed)
 
bool IsPrecaching ()
 
void BoostPriority (EPSOPrecachePriority PSOPrecachePriority, const FPSOPrecacheRequestID &RequestID)
 
uint32 NumActivePrecacheRequests ()
 
void PrecacheFinished (const TPrecachedPSOInitializer &Initializer, bool bValid)
 
void ProcessDelayedCleanup ()
 
void MarkPSOAsUsed (const TPrecachedPSOInitializer &Initializer)
 

Static Public Member Functions

static bool IsCompilationDone (EPSOPrecacheStateMask StateMask)
 

Protected Member Functions

void RescheduleTaskToHighPriority (EPSOPrecacheStateMask NewState, EPSOPrecacheStateMask PrevState, TPipelineState *PipelineState)
 
FPSOPrecacheRequestResult TryAddNewState (const TPrecachedPSOInitializer &Initializer, const FString &PSOCompilationEventName, bool bDoAsyncCompile)
 
bool HasPSOBeenRequested (const TPrecachedPSOInitializer &Initializer, uint64 InitializerHash, FPSOPrecacheRequestResult &Result)
 
EPSOPrecacheResult GetPrecachingStateInternal (uint64 InitializerHash, bool bTryMarkUsed, bool &bOutMarkedUsed)
 
void UpdateActiveCompileCount (bool bIncrement)
 
void UpdateHighPriorityCompileCount (bool bIncrement)
 
void UpdateHighestPriorityCompileCount (bool bIncrement)
 

Protected Attributes

FPSOPrecacheRequestID::EType PSOType
 
FRWLock PrecachePSOsRWLock
 
TArray< uint64 > PrecachedPSOInitializers
 
TMap< uint64, FPrecacheTask > PrecachedPSOInitializerData
 
volatile int32 ActiveCompileCount = 0
 
volatile int32 HighPriorityCompileCount = 0
 
volatile int32 HighestPriorityCompileCount = 0
 
TArray< uint64 > PrecachedPSOsToCleanup
 
TDeque< uint32 > InMemoryPSOIndices
 
uint32 MaxInMemoryPSOs = 0
 

Constructor & Destructor Documentation

◆ TPrecachePipelineCacheBase()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::TPrecachePipelineCacheBase ( FPSOPrecacheRequestID::EType  InType,
uint32  InMaxInMemoryPSOs 
)
inline

◆ ~TPrecachePipelineCacheBase()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::~TPrecachePipelineCacheBase ( )
inline

Member Function Documentation

◆ BoostPriority()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::BoostPriority ( EPSOPrecachePriority  PSOPrecachePriority,
const FPSOPrecacheRequestID &  RequestID 
)
inline

◆ GetPrecachingState() [1/2]

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
EPSOPrecacheResult TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::GetPrecachingState ( const FPSOPrecacheRequestID &  RequestID)
inline

◆ GetPrecachingState() [2/2]

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
EPSOPrecacheResult TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::GetPrecachingState ( const TPrecachedPSOInitializer &  Initializer)
inline

◆ GetPrecachingStateAndMarkUsed()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
EPSOPrecacheResult TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::GetPrecachingStateAndMarkUsed ( const TPrecachedPSOInitializer &  Initializer,
bool &  bOutMarkedUsed 
)
inline

◆ GetPrecachingStateInternal()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
EPSOPrecacheResult TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::GetPrecachingStateInternal ( uint64  InitializerHash,
bool  bTryMarkUsed,
bool &  bOutMarkedUsed 
)
inlineprotected

◆ HasPSOBeenRequested()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
bool TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::HasPSOBeenRequested ( const TPrecachedPSOInitializer &  Initializer,
uint64  InitializerHash,
FPSOPrecacheRequestResult &  Result 
)
inlineprotected

◆ IsCompilationDone()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
static bool TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::IsCompilationDone ( EPSOPrecacheStateMask  StateMask)
inlinestatic

◆ IsPrecaching()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
bool TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::IsPrecaching ( )
inline

◆ MarkPSOAsUsed()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::MarkPSOAsUsed ( const TPrecachedPSOInitializer &  Initializer)
inline

◆ NumActivePrecacheRequests()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
uint32 TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::NumActivePrecacheRequests ( )
inline

◆ PrecacheFinished()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PrecacheFinished ( const TPrecachedPSOInitializer &  Initializer,
bool  bValid 
)
inline

◆ ProcessDelayedCleanup()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::ProcessDelayedCleanup ( )
inline

◆ RescheduleTaskToHighPriority()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::RescheduleTaskToHighPriority ( EPSOPrecacheStateMask  NewState,
EPSOPrecacheStateMask  PrevState,
TPipelineState *  PipelineState 
)
inlineprotected

◆ SetMaxInMemoryPSOs()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::SetMaxInMemoryPSOs ( uint32  NewMaxInMemoryPSOs)
inline

◆ TryAddNewState()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
FPSOPrecacheRequestResult TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::TryAddNewState ( const TPrecachedPSOInitializer &  Initializer,
const FString &  PSOCompilationEventName,
bool  bDoAsyncCompile 
)
inlineprotected

◆ UpdateActiveCompileCount()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::UpdateActiveCompileCount ( bool  bIncrement)
inlineprotected

◆ UpdateHighestPriorityCompileCount()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::UpdateHighestPriorityCompileCount ( bool  bIncrement)
inlineprotected

◆ UpdateHighPriorityCompileCount()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::UpdateHighPriorityCompileCount ( bool  bIncrement)
inlineprotected

◆ WaitTasksComplete()

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
void TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::WaitTasksComplete ( )
inline

Member Data Documentation

◆ ActiveCompileCount

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
volatile int32 TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::ActiveCompileCount = 0
protected

◆ HighestPriorityCompileCount

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
volatile int32 TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::HighestPriorityCompileCount = 0
protected

◆ HighPriorityCompileCount

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
volatile int32 TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::HighPriorityCompileCount = 0
protected

◆ InMemoryPSOIndices

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TDeque<uint32> TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::InMemoryPSOIndices
protected

◆ MaxInMemoryPSOs

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
uint32 TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::MaxInMemoryPSOs = 0
protected

◆ PrecachedPSOInitializerData

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TMap<uint64, FPrecacheTask> TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PrecachedPSOInitializerData
protected

◆ PrecachedPSOInitializers

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TArray<uint64> TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PrecachedPSOInitializers
protected

◆ PrecachedPSOsToCleanup

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
TArray<uint64> TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PrecachedPSOsToCleanup
protected

◆ PrecachePSOsRWLock

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
FRWLock TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PrecachePSOsRWLock
protected

◆ PSOType

template<class TPrecachePipelineCacheDerived , class TPrecachedPSOInitializer , class TPipelineState >
FPSOPrecacheRequestID::EType TPrecachePipelineCacheBase< TPrecachePipelineCacheDerived, TPrecachedPSOInitializer, TPipelineState >::PSOType
protected
The documentation for this class was generated from the following file: