FRHIPoolAllocator | Unreal Engine 5.4 Documentation

References


Module	RHICore
Header	/Engine/Source/Runtime/RHICore/Public/RHIPoolAllocator.h
Include	#include "RHIPoolAllocator.h"

class FRHIPoolAllocator

Manages an array of FRHIMemoryPool and supports defragmentation between multiple pools

Type	Name	Description
const bool	bDefragEnabled
FCriticalSection	CS	Critical section to lock access to the pools.
const uint64	DefaultPoolSize	Const creation members - used to create new pools.
const FRHIMemoryPool::EFreeListOrder	FreeListOrder
int32	LastDefragPoolIndex	Last defrag pool index - defrag is time slices to reduce CPU overhead.
const uint64	MaxAllocationSize
const uint32	PoolAlignment
TArray< uint32 >	PoolAllocationOrder	Allocation order of the pools when performing new allocations Can' sort the pools directly because pool index is stored in the allocation info
TArray< FRHIMemoryPool * >	Pools	Actual pools managing each a linked list of allocations.
uint32	TotalAllocatedBlocks	Stats.

	Type	Name	Description
		FRHIPoolAllocator ( uint64 InDefaultPoolSize, uint32 InPoolAlignment, uint32 InMaxAllocationSize, FRHIMemoryPool::EFreeListOrder InFreeListOrder, bool InDefragEnabled )	Constructor.

	Type	Name	Description
		~FRHIPoolAllocator ()

Type	Name	Description
FRHIMemoryPool *	CreateNewPool ( int16 InPoolIndex, uint32 InMinimumAllocationSize, ERHIPoolResourceTypes InAllocationResourceType )	Helper function to create a new platform specific pool.
void	DeallocateInternal ( FRHIPoolAllocationData& AllocationData )
void	Defrag ( FRHICommandListBase& RHICmdList, uint32 InMaxCopySize, uint32& CurrentCopySize )	Defrag & cleanup operation.
void	Destroy ()
bool	HandleDefragRequest ( FRHICommandListBase& RHICmdList, FRHIPoolAllocationData* InSourceBlock, FRHIPoolAllocationData& InTmpTargetBlock )
void	Initialize ()	Setup/Shutdown.
bool	TryAllocateInternal ( uint32 InSizeInBytes, uint32 InAllocationAlignment, ERHIPoolResourceTypes InAllocationResourceType, FRHIPoolAllocationData& AllocationData )	Supported allocator operations.
void	UpdateMemoryStats ( uint32& IOMemoryAllocated, uint32& IOMemoryUsed, uint32& IOMemoryFree, uint32& IOMemoryEndFree, uint32& IOAlignmentWaste, uint32& IOAllocatedPageCount, uint32& IOFullPageCount )	Stats.