SysAllocWinAPI

Scaleform::SysAllocWinAPI

Declaration

class SysAllocWinAPI : public SysAllocBase_SingletonSupport<SysAllocWinAPI, SysAllocPaged>;

Description

SysAllocWinAPI is a default system specific implementation of SysAllocPaged interface that makes use of VirtualAlloc/VirtualFree and is suited for the Windows and Xbox 360 platforms. The system specific allocator allows large memory request to be handled as the virtual memory manager reuses the separate memory blocks.

Since SysAllocWinAPI relies on the low-level OS functions, it intelligently considers both system page size and granularity, allowing it to be particularly alignment friendly. Due to this alignment efficiency, SysAllocWinAPI does not lose any memory on 4K alignment required internally by MemoryHeap. No alignment overhead means that SysAllocWinAPI uses memory and address space with maximum efficiency, making it the best choice for the GFx system allocator on Microsoft platforms.

Methods

Method	Description
Alloc	Allocates a virtual block of memory of specified size to the heap.
Free	Frees the virtual block of memory allocated by Alloc.
GetInfo	Returns the allocator alignment support and granularity capabilities of the system allocator implementation by filling in the SysAllocPaged::Info structure members.
ReallocInPlace	Attempts to reallocate the memory to a new size without moving it.
GetUsedSpace	Returns the actual amount of allocated/used bytes in the heap.
GetFootprint	Returns the number of bytes allocated from the system for the system allocator.
SysAllocWinAPI	Initializes the system allocator.

File

HeapPT_SysAllocWinAPI.h