TRHITransientResourceCache< TransientResourceType > Class Template Reference

#include <RHICoreTransientResourceAllocator.h>

Public Member Functions
	TRHITransientResourceCache (uint32 InCapacity=kDefaultCapacity, uint32 InGarbageCollectLatency=kDefaultGarbageCollectLatency)
	~TRHITransientResourceCache ()
template<typename CreateFunctionType >
TransientResourceType *	Acquire (uint64 Hash, CreateFunctionType CreateFunction)
template<typename ReleaseFunctionType >
void	Forfeit (uint64 CurrentFrameIndex, ReleaseFunctionType ReleaseFunction)
void	Forfeit (uint64 CurrentFrameIndex)
TConstArrayView< TransientResourceType * >	GetAllocated () const
uint32	GetAllocatedCount () const
uint32	GetSize () const
uint32	GetCapacity () const
uint32	GetHitCount () const
uint32	GetMissCount () const
float	GetHitPercentage () const

Static Public Attributes
static const uint32	kInfinity = ~0u
static const uint32	kDefaultCapacity = kInfinity
static const uint32	kDefaultGarbageCollectLatency = 32

Detailed Description

template<typename TransientResourceType>
class TRHITransientResourceCache< TransientResourceType >

An RHI transient resource cache designed to optimize fetches for resources placed into a heap with an offset. The cache has a fixed capacity whereby no garbage collection will occur. Once that capacity is exceeded, garbage collection is invoked on resources older than a specified generation (where generation is incremented with each cycle of forfeiting acquired resources).

Constructor & Destructor Documentation

TRHITransientResourceCache()

template<typename TransientResourceType >

TRHITransientResourceCache< TransientResourceType >::TRHITransientResourceCache ( uint32  InCapacity = kDefaultCapacity, uint32  InGarbageCollectLatency = kDefaultGarbageCollectLatency  )

inline

~TRHITransientResourceCache()

template<typename TransientResourceType >

TRHITransientResourceCache< TransientResourceType >::~TRHITransientResourceCache ( )

inline

Member Function Documentation

Acquire()

template<typename TransientResourceType >

template<typename CreateFunctionType >

TransientResourceType * TRHITransientResourceCache< TransientResourceType >::Acquire ( uint64  Hash, CreateFunctionType  CreateFunction  )

inline

Forfeit() [1/2]

template<typename TransientResourceType >

void TRHITransientResourceCache< TransientResourceType >::Forfeit ( uint64  CurrentFrameIndex )

inline

Forfeit() [2/2]

template<typename TransientResourceType >

template<typename ReleaseFunctionType >

void TRHITransientResourceCache< TransientResourceType >::Forfeit ( uint64  CurrentFrameIndex, ReleaseFunctionType  ReleaseFunction  )

inline

GetAllocated()

template<typename TransientResourceType >

TConstArrayView< TransientResourceType * > TRHITransientResourceCache< TransientResourceType >::GetAllocated ( ) const

inline

GetAllocatedCount()

template<typename TransientResourceType >

uint32 TRHITransientResourceCache< TransientResourceType >::GetAllocatedCount ( ) const

inline

GetCapacity()

template<typename TransientResourceType >

uint32 TRHITransientResourceCache< TransientResourceType >::GetCapacity ( ) const

inline

GetHitCount()

template<typename TransientResourceType >

uint32 TRHITransientResourceCache< TransientResourceType >::GetHitCount ( ) const

inline

GetHitPercentage()

template<typename TransientResourceType >

float TRHITransientResourceCache< TransientResourceType >::GetHitPercentage ( ) const

inline

GetMissCount()

template<typename TransientResourceType >

uint32 TRHITransientResourceCache< TransientResourceType >::GetMissCount ( ) const

inline

GetSize()

template<typename TransientResourceType >

uint32 TRHITransientResourceCache< TransientResourceType >::GetSize ( ) const

inline

Member Data Documentation

kDefaultCapacity

template<typename TransientResourceType >

const uint32 TRHITransientResourceCache< TransientResourceType >::kDefaultCapacity = kInfinity

static

kDefaultGarbageCollectLatency

template<typename TransientResourceType >

const uint32 TRHITransientResourceCache< TransientResourceType >::kDefaultGarbageCollectLatency = 32

static

kInfinity

template<typename TransientResourceType >

const uint32 TRHITransientResourceCache< TransientResourceType >::kInfinity = ~0u

static

---

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

• Engine/Source/Runtime/RHICore/Public/RHICoreTransientResourceAllocator.h