Navigation
API > API/Runtime > API/Runtime/RHICore
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.
| Name | FRHITransientHeapCache |
| Type | class |
| Header File | /Engine/Source/Runtime/RHICore/Public/RHICoreTransientResourceAllocator.h |
| Include Path | #include "RHICoreTransientResourceAllocator.h" |
Syntax
class FRHITransientHeapCache : public IRHITransientMemoryCache
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITransientHeapCache
(
const FInitializer& InInitializer |
RHICoreTransientResourceAllocator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRHITransientHeapCache() |
RHICoreTransientResourceAllocator.h |
Structs
| Name | Remarks |
|---|---|
| FInitializer |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CriticalSection | FCriticalSection | RHICoreTransientResourceAllocator.h | ||
| FreeList | TArray< FRHITransientHeap * > | RHICoreTransientResourceAllocator.h | ||
| FRHITransientResourceHeapAllocator | friend | RHICoreTransientResourceAllocator.h | ||
| GarbageCollectCycle | uint64 | RHICoreTransientResourceAllocator.h | ||
| Initializer | FInitializer | RHICoreTransientResourceAllocator.h | ||
| LiveList | TArray< FRHITransientHeap * > | RHICoreTransientResourceAllocator.h | ||
| Stats | FRHITransientMemoryStats | RHICoreTransientResourceAllocator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITransientHeap * Acquire
(
uint64 FirstAllocationSize, |
RHICoreTransientResourceAllocator.h | ||
void Forfeit
(
TConstArrayView< FRHITransientHeap* > Heaps |
RHICoreTransientResourceAllocator.h | ||
uint64 GetGarbageCollectCycle() |
RHICoreTransientResourceAllocator.h | ||
uint64 GetHeapSize
(
uint64 RequestedHeapSize |
RHICoreTransientResourceAllocator.h | ||
const FInitializer & GetInitializer() |
RHICoreTransientResourceAllocator.h |
Overridden from IRHITransientMemoryCache
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GarbageCollect() |
RHICoreTransientResourceAllocator.h |