OSInitAlloc

Syntax

#include <revolution/os.h>

void* OSInitAlloc(void* arenaStart, void* arenaEnd, int maxHeaps);

Arguments

*`arenaStart`*	Arena start address.
*`arenaEnd`*	Arena end address.
*`maxHeaps`*	Maximum number of active heaps that will be used in the program lifetime.

Return Values

Real arena start address aligned to a 32-byte boundary after the heap array has been allocated.

Description

Although this function is provided for the sake of compatibility, we recommend using the MEM library.

Initializes memory allocation services and the arena in which all heaps will reside. This routine must be called before creating a heap.

Several small pieces of memory used to store an array of heap descriptors are reserved at the beginning of the arena. Returns the base address of the new arena.

Revision History

2006/03/01 Initial version.