RecastAlloc.cpp File Reference

#include "RecastAlloc.h"

Functions
static void *	rcAllocDefault (size_t size, rcAllocHint)
static void	rcFreeDefault (void *ptr)
void	rcAllocSetCustom (rcAllocFunc *allocFunc, rcFreeFunc *freeFunc)
	Sets the base custom allocation functions to be used by Recast.
void *	rcAlloc (size_t size, rcAllocHint hint)
	Allocates a memory block.
void	rcFree (void *ptr)
	Deallocates a memory block.

Variables
static rcAllocFunc *	sRecastAllocFunc = rcAllocDefault
static rcFreeFunc *	sRecastFreeFunc = rcFreeDefault

Function Documentation

rcAlloc()

void * rcAlloc	(	size_t	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

rcAllocDefault()

static void * rcAllocDefault ( size_t  size, rcAllocHint    )

static

rcAllocSetCustom()

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

rcFree()

void rcFree

(

void *

ptr

)

Deallocates a memory block.

If ptr is NULL, this does nothing.

Warning

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

Parameters

[in]

ptr

A pointer to a memory block previously allocated using rcAlloc.

See also

rcAlloc, rcAllocSetCustom

rcFreeDefault()

static void rcFreeDefault ( void *  ptr )

static

Variable Documentation

sRecastAllocFunc

rcAllocFunc* sRecastAllocFunc = rcAllocDefault

static

sRecastFreeFunc

rcFreeFunc* sRecastFreeFunc = rcFreeDefault

static