RecastAlloc.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	rcIntArray
	A simple dynamic array of integers. More...
class	rcScopedDelete< T >

Typedefs
typedef void *(	rcAllocFunc )(int size, rcAllocHint hint)
	A memory allocation function. More...
typedef void(	rcFreeFunc )(void *ptr)

Enumerations
enum	rcAllocHint { RC_ALLOC_PERM, RC_ALLOC_TEMP }

Functions
void	rcAllocSetCustom (rcAllocFunc *allocFunc, rcFreeFunc *freeFunc)
void *	rcAlloc (int size, rcAllocHint hint)
void	rcFree (void *ptr)

Typedef Documentation

typedef void*( rcAllocFunc)(int size, rcAllocHint hint)

A memory allocation function.

See also

rcAllocSetCustom

typedef void( rcFreeFunc)(void *ptr)

A memory deallocation function.

Parameters

[in]

ptr

A pointer to a memory block previously allocated using rcAllocFunc.

See also

rcAllocSetCustom

Enumeration Type Documentation

enum rcAllocHint

Provides hint values to the memory allocator on how long the memory is expected to be used.

Enumerator
RC_ALLOC_PERM	Memory will persist after a function call.
RC_ALLOC_TEMP	Memory used temporarily within a function.

{
 RC_ALLOC_PERM, 
 RC_ALLOC_TEMP 
};

Function Documentation

void* rcAlloc	(	int	size,
		rcAllocHint	hint
	)

Allocates a memory block.

Parameters

[in]	size	The size, in bytes of memory, to allocate.
[in]	hint	A hint to the allocator on how long the memory is expected to be in use.

Returns

A pointer to the beginning of the allocated memory block, or null if the allocation failed.

See also

rcFree

rcAllocSetCustom

{
 return sRecastAllocFunc(size, hint);
}

Here is the caller graph for this function:

void rcAllocSetCustom	(	rcAllocFunc *	allocFunc,
		rcFreeFunc *	freeFunc
	)

Sets the base custom allocation functions to be used by Recast.

Parameters

[in]	allocFunc	The memory allocation function to be used by rcAlloc
[in]	freeFunc	The memory de-allocation function to be used by rcFree

See also

rcAlloc, rcFree

{
 sRecastAllocFunc = allocFunc ? allocFunc : rcAllocDefault;
 sRecastFreeFunc = freeFunc ? freeFunc : rcFreeDefault;
}

Here is the call graph for this function:

void rcFree

(

void *

ptr

)

Deallocates a memory block.

Parameters

[in]

ptr

A pointer to a memory block previously allocated using rcAlloc.

See also

rcAlloc

Warning

This function leaves the value of ptr unchanged. So it still points to the same (now invalid) location, and not to null.

See also

rcAllocSetCustom

{
 if (ptr)
 sRecastFreeFunc(ptr);
}

Here is the caller graph for this function: