Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FMallocBinned

Malloc binned allocator specific stats. Optimized virtual memory allocator.

Windows

MacOS

Linux

Inheritance Hierarchy

FUseSystemMallocForNew

FExec

FMalloc

FMallocBinned

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/HAL/MallocBinned.h
Include	#include "HAL/MallocBinned.h"

Syntax

class FMallocBinned : public FMalloc

Remarks

Malloc binned allocator specific stats. Optimized virtual memory allocator.

Constructors

	Name	Description
	FMallocBinned ( uint32 InPageSize, uint64 AddressLimit )	InPageSize - First parameter is page size, all allocs from BinnedAllocFromOS() MUST be aligned to this size AddressLimit - Second parameter is estimate of the range of addresses expected to be returns by BinnedAllocFromOS().

Destructors

	Name	Description
	~FMallocBinned()

Overridden from FMalloc

	Name	Description
void	DumpAllocatorStats ( FOutputDevice& Ar )	Dumps allocator stats to an output device. Subclasses should override to add additional info
void	Free ( void* Ptr )	Free
bool	GetAllocationSize ( void* Original, SIZE_T& SizeOut )	If possible determine the size of the memory allocated at the given address
void	GetAllocatorStats ( FGenericMemoryStats& out_Stats )	Writes allocator stats from the last update into the specified destination.
const TCHAR ...	GetDescriptiveName()	Gets descriptive name for logging purposes.
void	InitializeStatsMetadata()	Initializes stats metadata.
bool	IsInternallyThreadSafe()	Returns if the allocator is guaranteed to be thread-safe and therefore doesn't need a unnecessary thread-safety wrapper around it.
void *	Malloc ( SIZE_T Size, uint32 Alignment )	Malloc
SIZE_T	QuantizeSize ( SIZE_T Count, uint32 Alignment )	For some allocators this will return the actual size that should be requested to eliminate internal fragmentation.
void *	Realloc ( void* Ptr, SIZE_T NewSize, uint32 Alignment )	Realloc
void	UpdateStats()	Called once per frame, gathers and sets all memory allocator statistics into the corresponding stats.
bool	ValidateHeap()	Validates the allocator's heap

Classes

	Name	Description
	FFreeMem	Information about a piece of free memory. 8 bytes
	FPoolInfo
	PoolHashBucket	Hash table struct for retrieving allocation book keeping information
	Private

Constants

Name	Description
EXTENDED_PAGE_POOL_ALLOCATION_COUNT	Maximum allocation for the pooled allocator
MAX_POOLED_ALLOCATION_SIZE
POOL_COUNT	Counts.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss