Navigation
API > API/Runtime > API/Runtime/RHICore
The base class for a platform heap implementation. Transient resources are placed on the heap at specific byte offsets. Each heap additionally contains a cache of RHI transient resources, each with its own RHI resource and cache of RHI views. The lifetime of the resource cache is tied to the heap.
| Name | FRHITransientHeap |
| Type | class |
| Header File | /Engine/Source/Runtime/RHICore/Public/RHICoreTransientResourceAllocator.h |
| Include Path | #include "RHICoreTransientResourceAllocator.h" |
Syntax
class FRHITransientHeap
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITransientHeap
(
const FInitializer& InInitializer |
RHICoreTransientResourceAllocator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRHITransientHeap() |
RHICoreTransientResourceAllocator.h |
Structs
| Name | Remarks |
|---|---|
| FInitializer | |
| FResourceInitializer |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCreateBufferFunction | TFunction< FRHITransientBuffer *(const FResourceInitializer &)> | RHICoreTransientResourceAllocator.h | |
| FCreateTextureFunction | TFunction< FRHITransientTexture *(const FResourceInitializer &)> | RHICoreTransientResourceAllocator.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AliasingOverlaps | TArray< FRHITransientHeapAllocator::FAliasingOverlap > | RHICoreTransientResourceAllocator.h | ||
| AlignmentLog2 | uint32 | RHICoreTransientResourceAllocator.h | ||
| Allocator | FRHITransientHeapAllocator | RHICoreTransientResourceAllocator.h | ||
| Buffers | TRHITransientResourceCache< FRHITransientBuffer > | RHICoreTransientResourceAllocator.h | ||
| CommitSize | uint64 | RHICoreTransientResourceAllocator.h | ||
| CommitSizeMax | uint64 | RHICoreTransientResourceAllocator.h | ||
| FRHITransientHeapCache | friend | RHICoreTransientResourceAllocator.h | ||
| FRHITransientResourceHeapAllocator | friend | RHICoreTransientResourceAllocator.h | ||
| Initializer | FInitializer | RHICoreTransientResourceAllocator.h | ||
| LastUsedGarbageCollectCycle | uint64 | RHICoreTransientResourceAllocator.h | ||
| Stats | FRHITransientMemoryStats | RHICoreTransientResourceAllocator.h | ||
| Textures | TRHITransientResourceCache< FRHITransientTexture > | RHICoreTransientResourceAllocator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITransientBuffer * CreateBuffer
(
const FRHIBufferCreateInfo& CreateInfo, |
RHICoreTransientResourceAllocator.h | ||
FRHITransientTexture * CreateTexture
(
const FRHITextureCreateInfo& CreateInfo, |
RHICoreTransientResourceAllocator.h | ||
void DeallocateMemory
(
FRHITransientTexture* Texture, |
RHICoreTransientResourceAllocator.h | ||
void DeallocateMemory
(
FRHITransientBuffer* Buffer, |
RHICoreTransientResourceAllocator.h | ||
void Flush
(
uint64 CurrentAllocatorCycle, |
RHICoreTransientResourceAllocator.h | ||
uint64 GetCapacity() |
RHICoreTransientResourceAllocator.h | ||
uint64 GetCommitSize() |
RHICoreTransientResourceAllocator.h | ||
uint64 GetGPUVirtualAddress() |
RHICoreTransientResourceAllocator.h | ||
const FInitializer & GetInitializer() |
RHICoreTransientResourceAllocator.h | ||
uint64 GetLastUsedGarbageCollectCycle() |
RHICoreTransientResourceAllocator.h | ||
bool IsAllocationSupported
(
uint64 Size, |
RHICoreTransientResourceAllocator.h | ||
bool IsCommitRequired() |
RHICoreTransientResourceAllocator.h | ||
bool IsEmpty() |
RHICoreTransientResourceAllocator.h | ||
bool IsFull() |
RHICoreTransientResourceAllocator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetGpuVirtualAddress
(
uint64 InBaseGPUVirtualAddress |
RHICoreTransientResourceAllocator.h |