Planeshift
Classes | Typedefs | Enumerations | Functions

RecastAlloc.h File Reference

Go to the source code of this file.

Classes

class  rcIntArray
 A simple dynamic array of integers. More...
class  rcScopedDelete< T >
 A simple helper class used to delete an array when it goes out of scope. More...

Typedefs

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

Enumerations

enum  rcAllocHint { RC_ALLOC_PERM, RC_ALLOC_TEMP }
 

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

More...

Functions

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

Typedef Documentation

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

A memory allocation function.

See also:
rcAllocSetCustom

Definition at line 35 of file RecastAlloc.h.

typedef void( rcFreeFunc)(void *ptr)

A memory deallocation function.

Parameters:
[in]ptrA pointer to a memory block previously allocated using rcAllocFunc.
See also:
rcAllocSetCustom

Definition at line 40 of file RecastAlloc.h.


Enumeration Type Documentation

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.

Definition at line 24 of file RecastAlloc.h.


Function Documentation

void* rcAlloc ( int  size,
rcAllocHint  hint 
)

Allocates a memory block.

Parameters:
[in]sizeThe size, in bytes of memory, to allocate.
[in]hintA 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
void rcAllocSetCustom ( rcAllocFunc allocFunc,
rcFreeFunc freeFunc 
)

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

Parameters:
[in]allocFuncThe memory allocation function to be used by rcAlloc
[in]freeFuncThe memory de-allocation function to be used by rcFree
void rcFree ( void *  ptr)

Deallocates a memory block.

Parameters:
[in]ptrA pointer to a memory block previously allocated using rcAlloc.
See also:
rcAlloc