PathEngine_SetDefaultAllocator

Description

Enables a custom allocation strategy to be supplied for PathEngine internal allocations (default allocator).

Syntax

extern "C"
{
void PathEngine_SetDefaultAllocator(iAllocator* allocator);
}

Parameters

Remarks

This function is for use when statically linking against the SDK.
(Pass an allocator pointer into DLLExport_Init to set a custom allocator when linking with PathEngine as a DLL.)

This function can only be called

before

The pointed to allocator object must then remain valid either until PathEngine is explicitly shut down, or until global or static object destruction time.
It is ok for the allocator object to be declared as a global (or static) scoped object, since PathEngine does not allocate memory from any global (or static) objects internally.

Explicit shutdown with PathEngine_ShutDown() is necessary if you want to ensure that each allocation is matched with a call to free(), i.e. with leak checking allocators.