MEMInitAllocatorForFrmHeap

Syntax

#include <cafe/mem.h>

void MEMInitAllocatorForFrmHeap(
                        MEMAllocator*    pAllocator,
                        MEMHeapHandle    heap,
                        int              alignment );

Parameters

pAllocator Address of the MemAllocator structure.
heap Frame heap handle.
alignment Alignment value applied to each memory block to allocate.

Return Values

None.

Description

Initializes the allocator to allocate and deallocate memory from the frame heap. The alignment values of all memory blocks allocated through this allocator are specified by alignment.

Memory blocks cannot be deallocated in block units for the frame heap, so the MEMFreeToAllocator function does nothing for allocators set to use the frame heap.

Do Not Call From

Multiple threads This function is not thread-safe.
Callbacks Do not call this function from any callback function.

See Also

MEMInitAllocatorForBlockHeap
MEMInitAllocatorForExpHeap
MEMInitAllocatorForUnitHeap

Revision History

2013-05-08 Automated cleanup pass.
2010-11-01 Initial version.


CONFIDENTIAL