class Heap

Defined in: C4Memory.h

The Heap class encapsulates a memory allocation heap.

Definition

class Heap

Member Functions

Heap::GetTotalSize Returns the total size of allocated blocks in a heap.

Parameters

`name`	The name of the heap.
`pool`	The size of allocation pools allocated in the heap.

Constructor

Heap(const char *name = nullptr, unsigned long pool = kMemoryDefaultPoolSize);

Description

The Heap class organizes a set of memory pools from which blocks of memory are allocated by the Memory Manager. Heaps are generally managed internally by the engine, but it is possible to create new dedicated heaps for custom class types by subclassing from the Memory class.