UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FD3D12LocalOnlineHeap Class Reference

#include <D3D12DescriptorCache.h>

+ Inheritance diagram for FD3D12LocalOnlineHeap:

Public Member Functions

 FD3D12LocalOnlineHeap (FD3D12DescriptorCache &DescriptorCache, FD3D12CommandContext &Context)
 
void Init (uint32 InNumDescriptors, ERHIDescriptorHeapType InHeapType)
 
virtual bool RollOver () final override
 
virtual void HeapLoopedAround () final override
 
virtual void OpenCommandList () final override
 
virtual void CloseCommandList () final override
 
- Public Member Functions inherited from FD3D12OnlineHeap
 FD3D12OnlineHeap (FD3D12Device *Device, bool CanLoopAround)
 
virtual ~FD3D12OnlineHeap ()
 
ID3D12DescriptorHeapGetHeap ()
 
FORCEINLINE D3D12_CPU_DESCRIPTOR_HANDLE GetCPUSlotHandle (uint32 Slot) const
 
FORCEINLINE D3D12_GPU_DESCRIPTOR_HANDLE GetGPUSlotHandle (uint32 Slot) const
 
bool CanReserveSlots (uint32 NumSlots)
 
uint32 ReserveSlots (uint32 NumSlotsRequested)
 
void SetNextSlot (uint32 NextSlot)
 
uint32 GetNextSlotIndex () const
 
virtual uint32 GetTotalSize ()
 
- Public Member Functions inherited from FD3D12DeviceChild
 FD3D12DeviceChild (FD3D12Device *InParent=nullptr)
 
FORCEINLINE FD3D12DeviceGetParentDevice () const
 
FD3D12DeviceGetParentDevice_Unsafe () const
 

Additional Inherited Members

- Protected Attributes inherited from FD3D12OnlineHeap
TRefCountPtr< FD3D12DescriptorHeapHeap
 
uint32 NextSlotIndex = 0
 
uint32 FirstUsedSlot = 0
 
const bool bCanLoopAround
 
- Protected Attributes inherited from FD3D12DeviceChild
FD3D12DeviceParent
 

Detailed Description

Online heap which is not shared between multiple FD3D12DescriptorCache. Used as overflow heap when the global heaps are full or don't contain the required data

Constructor & Destructor Documentation

◆ FD3D12LocalOnlineHeap()

FD3D12LocalOnlineHeap::FD3D12LocalOnlineHeap ( FD3D12DescriptorCache DescriptorCache,
FD3D12CommandContext Context 
)

Member Function Documentation

◆ CloseCommandList()

void FD3D12LocalOnlineHeap::CloseCommandList ( )
finaloverridevirtual

Reimplemented from FD3D12OnlineHeap.

◆ HeapLoopedAround()

void FD3D12LocalOnlineHeap::HeapLoopedAround ( )
finaloverridevirtual

Handle loop around on the heap

Reimplemented from FD3D12OnlineHeap.

◆ Init()

void FD3D12LocalOnlineHeap::Init ( uint32  InNumDescriptors,
ERHIDescriptorHeapType  InHeapType 
)

Initialize a thread local online heap

◆ OpenCommandList()

void FD3D12LocalOnlineHeap::OpenCommandList ( )
finaloverridevirtual

Reimplemented from FD3D12OnlineHeap.

◆ RollOver()

bool FD3D12LocalOnlineHeap::RollOver ( )
finaloverridevirtual

Handle roll over

Implements FD3D12OnlineHeap.


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