Memory

Scaleform::Memory

Declaration

class Memory;

Description

Memory maintains current heap and the global allocator, wrapping heap access functions. The main purpose of wrapping is to allow AllocInfo temporarily to be converted from a constant reference to an optional pointer argument for the allocation functions in MemoryHeap. Memory can be allocated either automatically (AllocAutoHeap) or in specified heaps (AllocInHeap).

Methods

Method	Description
Alloc	Allocates memory. Alloc of size==0 will allocate a tiny block and return a valid pointer.
AllocAutoHeap	Allocates memory block while automatically identifying heap and allocation id based on the specified address.
AllocInHeap	Allocates memory in the specified heap.
ArenaIsEmpty	Checks if the memory arena is empty.
CreateArena	Creates a memory arena that can be used by the heap for allocation purposes.
DestroyArena	Destroys the memory arena created for the heap.
DetectMemoryLeaks	Detects the memory leaks.
Free	Frees allocated/reallocated block set by Alloc or Realloc.
GetGlobalHeap	Returns a pointer to the global heap object through which all allocations takes place.
GetHeapByAddress	Obtains the heap to which the memory allocation belongs.
GetHeapByAddressOrNULL	Obtains the heap to which the memory allocation belongs or NULL if not found.
Realloc	Reallocates the memory block allocated by Alloc to a new size.
SetGlobalHeap	Sets the global heap object through which all memory allocations take place.

File

SF_Memory.h