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

#include <RHICoreTransientResourceAllocator.h>

Public Member Functions

 FRHITransientPageSpanAllocator (uint32 InPageCount, uint32 InPageSize)
 
RHICORE_API void Reset ()
 
RHICORE_API bool Allocate (FRHITransientResource *Resource, const FRHITransientAllocationFences &Fences, uint32 PageCount, uint32 &NumPagesAllocated, uint32 &OutSpanIndex)
 
RHICORE_API void Deallocate (FRHITransientResource *Resource, const FRHITransientAllocationFences &Fences, uint32 SpanIndex)
 
RHICORE_API void Flush ()
 
template<typename SpanArrayType >
void GetSpanArray (uint32 SpanIndex, SpanArrayType &OutPageSpans) const
 
uint32 GetAllocationCount () const
 
uint32 GetFreePageCount () const
 
uint64 GetUsedSize () const
 
uint64 GetFreeSize () const
 
RHICORE_API uint32 GetAllocationPageCount (uint32 SpanIndex) const
 
uint32 GetMaxSpanCount () const
 
uint32 GetPageSize () const
 
uint64 GetCapacity () const
 
bool IsFull () const
 
bool IsEmpty () const
 

Detailed Description

Allocates page spans for a resource.

Constructor & Destructor Documentation

◆ FRHITransientPageSpanAllocator()

FRHITransientPageSpanAllocator::FRHITransientPageSpanAllocator ( uint32  InPageCount,
uint32  InPageSize 
)
inline

Member Function Documentation

◆ Allocate()

bool FRHITransientPageSpanAllocator::Allocate ( FRHITransientResource Resource,
const FRHITransientAllocationFences Fences,
uint32  PageCount,
uint32 NumPagesAllocated,
uint32 OutSpanIndex 
)

◆ Deallocate()

void FRHITransientPageSpanAllocator::Deallocate ( FRHITransientResource Resource,
const FRHITransientAllocationFences Fences,
uint32  SpanIndex 
)

◆ Flush()

void FRHITransientPageSpanAllocator::Flush ( )

◆ GetAllocationCount()

uint32 FRHITransientPageSpanAllocator::GetAllocationCount ( ) const
inline

◆ GetAllocationPageCount()

uint32 FRHITransientPageSpanAllocator::GetAllocationPageCount ( uint32  SpanIndex) const

◆ GetCapacity()

uint64 FRHITransientPageSpanAllocator::GetCapacity ( ) const
inline

◆ GetFreePageCount()

uint32 FRHITransientPageSpanAllocator::GetFreePageCount ( ) const
inline

◆ GetFreeSize()

uint64 FRHITransientPageSpanAllocator::GetFreeSize ( ) const
inline

◆ GetMaxSpanCount()

uint32 FRHITransientPageSpanAllocator::GetMaxSpanCount ( ) const
inline

◆ GetPageSize()

uint32 FRHITransientPageSpanAllocator::GetPageSize ( ) const
inline

◆ GetSpanArray()

template<typename SpanArrayType >
void FRHITransientPageSpanAllocator::GetSpanArray ( uint32  SpanIndex,
SpanArrayType OutPageSpans 
) const
inline

◆ GetUsedSize()

uint64 FRHITransientPageSpanAllocator::GetUsedSize ( ) const
inline

◆ IsEmpty()

bool FRHITransientPageSpanAllocator::IsEmpty ( ) const
inline

◆ IsFull()

bool FRHITransientPageSpanAllocator::IsFull ( ) const
inline

◆ Reset()

void FRHITransientPageSpanAllocator::Reset ( )

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