FRHITransientHeapCache Class Reference

#include <RHICoreTransientResourceAllocator.h>

Inheritance diagram for FRHITransientHeapCache:

Classes
struct	FInitializer

Public Member Functions
	FRHITransientHeapCache (const FInitializer &InInitializer)
virtual RHICORE_API	~FRHITransientHeapCache ()
RHICORE_API FRHITransientHeap *	Acquire (uint64 FirstAllocationSize, ERHITransientHeapFlags FirstAllocationHeapFlags)
RHICORE_API void	Forfeit (TConstArrayView< FRHITransientHeap * > Heaps)
RHICORE_API void	GarbageCollect () override
const FInitializer &	GetInitializer () const
uint64	GetGarbageCollectCycle () const
uint64	GetHeapSize (uint64 RequestedHeapSize) const
Public Member Functions inherited from IRHITransientMemoryCache
virtual	~IRHITransientMemoryCache ()=default

Detailed Description

The RHI transient heap system is a base class for the platform implementation. It has a persistent lifetime and contains a cache of transient heaps. The transient allocator acquires heaps from the system and forfeits them at the end of its lifetime. Garbage collection of heaps is done using an internal counter that increments with each GarbageCollect call. This should be done periodically. Heaps older than a platform-specified fence latency are destroyed. Additionally, statistics are gathered automatically and reported to the 'rhitransientmemory' stats group.

Constructor & Destructor Documentation

FRHITransientHeapCache()

FRHITransientHeapCache::FRHITransientHeapCache ( const FInitializer &  InInitializer )

inline

~FRHITransientHeapCache()

FRHITransientHeapCache::~FRHITransientHeapCache ( )

virtual

Member Function Documentation

Acquire()

FRHITransientHeap * FRHITransientHeapCache::Acquire	(	uint64	FirstAllocationSize,
		ERHITransientHeapFlags	FirstAllocationHeapFlags
	)

Forfeit()

void FRHITransientHeapCache::Forfeit

(

TConstArrayView< FRHITransientHeap * >

Heaps

)

GarbageCollect()

void FRHITransientHeapCache::GarbageCollect ( )

overridevirtual

Implements IRHITransientMemoryCache.

GetGarbageCollectCycle()

uint64 FRHITransientHeapCache::GetGarbageCollectCycle ( ) const

inline

GetHeapSize()

uint64 FRHITransientHeapCache::GetHeapSize ( uint64  RequestedHeapSize ) const

inline

GetInitializer()

const FInitializer & FRHITransientHeapCache::GetInitializer ( ) const

inline

---

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

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