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

#include <RHIDescriptorAllocator.h>

+ Inheritance diagram for FRHIHeapDescriptorAllocator:

Public Member Functions

 FRHIHeapDescriptorAllocator ()=delete
 
RHICORE_API FRHIHeapDescriptorAllocator (ERHIDescriptorTypeMask InTypeMask, uint32 InDescriptorCount, TConstArrayView< TStatId > InStats)
 
RHICORE_API FRHIDescriptorHandle Allocate (ERHIDescriptorType InType)
 
RHICORE_API void Free (FRHIDescriptorHandle InHandle)
 
RHICORE_API TOptional< FRHIDescriptorAllocationAllocate (uint32 NumDescriptors)
 
RHICORE_API void Free (FRHIDescriptorAllocation Allocation)
 
ERHIDescriptorTypeMask GetTypeMask () const
 
bool HandlesAllocation (ERHIDescriptorType InType) const
 
bool HandlesAllocations (ERHIDescriptorTypeMask InTypeMask) const
 
RHICORE_API bool GetAllocatedRange (FRHIDescriptorAllocatorRange &OutRange)
 
uint32 GetCapacity () const
 
RHICORE_API TOptional< FRHIDescriptorAllocationResizeGrowAndAllocate (uint32 NewCapacity, uint32 NumAllocations)
 

Additional Inherited Members

- Protected Member Functions inherited from FRHIDescriptorAllocator
RHICORE_API FRHIDescriptorAllocator ()
 
RHICORE_API FRHIDescriptorAllocator (uint32 InNumDescriptors, TConstArrayView< TStatId > InStats)
 
RHICORE_API ~FRHIDescriptorAllocator ()
 
RHICORE_API void Init (uint32 InNumDescriptors, TConstArrayView< TStatId > InStats)
 
RHICORE_API void Shutdown ()
 
RHICORE_API TOptional< FRHIDescriptorAllocationResizeGrowAndAllocate (uint32 NewCapacity, uint32 NumAllocations)
 
RHICORE_API TOptional< FRHIDescriptorAllocationAllocate (uint32 NumDescriptors)
 
RHICORE_API void Free (FRHIDescriptorAllocation Allocation)
 
RHICORE_API FRHIDescriptorHandle Allocate (ERHIDescriptorType InType)
 
RHICORE_API void Free (FRHIDescriptorHandle InHandle)
 
RHICORE_API bool GetAllocatedRange (FRHIDescriptorAllocatorRange &OutRange)
 
uint32 GetCapacity () const
 

Constructor & Destructor Documentation

◆ FRHIHeapDescriptorAllocator() [1/2]

FRHIHeapDescriptorAllocator::FRHIHeapDescriptorAllocator ( )
delete

◆ FRHIHeapDescriptorAllocator() [2/2]

FRHIHeapDescriptorAllocator::FRHIHeapDescriptorAllocator ( ERHIDescriptorTypeMask  InTypeMask,
uint32  InDescriptorCount,
TConstArrayView< TStatId InStats 
)

Member Function Documentation

◆ Allocate() [1/2]

FRHIDescriptorHandle FRHIHeapDescriptorAllocator::Allocate ( ERHIDescriptorType  InType)

◆ Allocate() [2/2]

TOptional< FRHIDescriptorAllocation > FRHIHeapDescriptorAllocator::Allocate ( uint32  NumDescriptors)

◆ Free() [1/2]

void FRHIHeapDescriptorAllocator::Free ( FRHIDescriptorAllocation  Allocation)

◆ Free() [2/2]

void FRHIHeapDescriptorAllocator::Free ( FRHIDescriptorHandle  InHandle)

◆ GetAllocatedRange()

bool FRHIDescriptorAllocator::GetAllocatedRange ( FRHIDescriptorAllocatorRange OutRange)

◆ GetCapacity()

uint32 FRHIDescriptorAllocator::GetCapacity ( ) const
inline

◆ GetTypeMask()

ERHIDescriptorTypeMask FRHIHeapDescriptorAllocator::GetTypeMask ( ) const
inline

◆ HandlesAllocation()

bool FRHIHeapDescriptorAllocator::HandlesAllocation ( ERHIDescriptorType  InType) const
inline

◆ HandlesAllocations()

bool FRHIHeapDescriptorAllocator::HandlesAllocations ( ERHIDescriptorTypeMask  InTypeMask) const
inline

◆ ResizeGrowAndAllocate()

TOptional< FRHIDescriptorAllocation > FRHIDescriptorAllocator::ResizeGrowAndAllocate ( uint32  NewCapacity,
uint32  NumAllocations 
)

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