1. Epic GamesDeveloper
  3. FRHIMemoryPool

FRHIMemoryPool

[FRHIMemoryPool](API\Runtime\RHICore\FRHIMemoryPool).

API > API/Runtime > API/Runtime/RHICore

References

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

Syntax

class FRHIMemoryPool

Remarks

Pool which stores for each allocation the previous and next allocation. Each block is either free or allocated.

Variables

  Type Name Description
Protected variable uint64 AligmnentWaste  
Protected variable uint32 AllocatedBlocks  
Protected variable TArray< FRHIPoolAllocationData * > AllocationDataPool Allocation data pool used to reduce allocation overhead.
Protected variable TArray< FRHIPoolAllocationData * > FreeBlocks Actual Free blocks.
Protected variable const EFreeListOrder FreeListOrder  
Protected variable uint64 FreeSize Stats.
Protected variable FRHIPoolAllocationData HeadBlock Special start block to mark the beginning and the end of the linked list.
Protected variable const uint32 PoolAlignment  
Protected variable int16 PoolIndex Const creation members.
Protected variable const uint64 PoolSize  
Protected variable const ERHIPoolResourceTypes SupportedResourceTypes  

Constructors

  Type Name Description
Public function  

FRHIMemoryPool ( int16 InPoolIndex,
uint64 InPoolSize,
uint32 InPoolAlignment,
ERHIPoolResourceTypes InSupportedResourceTypes,
EFreeListOrder InFreeListOrder
)

 Constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function FRHIPoolAllocationData *  
Public function void

Deallocate ( FRHIPoolAllocationData& AllocationData
)

  
Public function Virtual void

Destroy ()

  
Protected function Const int32

FindFreeBlock ( uint32 InSizeInBytes,
uint32 InAllocationAlignment
)

 Free block management helper function.
Public function Static uint32

GetAlignedOffset ( uint32 InOffset,
uint32 InPoolAlignment,
uint32 InAllocationAlignment
)

  
Public function Static uint32

GetAlignedSize ( uint32 InSizeInBytes,
uint32 InPoolAlignment,
uint32 InAllocationAlignment
)

 Static public helper functions.
Public function Const uint32  
Public function Const uint32  
Public function Const uint64  
Protected function FRHIPoolAllocationData * Get/Release allocation data blocks.
Public function Const int16 Getters.
Public function Const uint64  
Public function Const ERHIPoolResourceTypes  
Public function Const uint64  
Public function Virtual void

Init ()

 Setup/Shutdown.
Public function Const bool

IsEmpty ()

  
Public function Const bool

IsFull ()

  
Public function Const bool

IsResourceTypeSupported ( ERHIPoolResourceTypes InType
)

  
Protected function void  
Protected function void  
Public function bool

TryAllocate ( uint32 InSizeInBytes,
uint32 InAllocationAlignment,
ERHIPoolResourceTypes InAllocationResourceType,
FRHIPoolAllocationData& AllocationData
)

 AllocationData functions: allocate, free, move, ...
Public function void

TryClear ( FRHIPoolAllocator* InAllocator,
uint32 InMaxCopySize,
uint32& CopySize,
const TArray< FRHIMemoryPool* >& InTargetPools
)

 Bookkeeping and clearing.
Protected function void Validate the linked list data - slow.

Enums

  Type Name Description
Public enum EFreeListOrder    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page