DetourAlloc.h File Reference

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

Go to the source code of this file.

Typedefs
typedef void *(	dtAllocFunc )(int size, dtAllocHint hint)
	A memory allocation function. More...
typedef void(	dtFreeFunc )(void *ptr)

Enumerations
enum	dtAllocHint { DT_ALLOC_PERM, DT_ALLOC_TEMP }

Functions
void	dtAllocSetCustom (dtAllocFunc *allocFunc, dtFreeFunc *freeFunc)
void *	dtAlloc (int size, dtAllocHint hint)
void	dtFree (void *ptr)

Typedef Documentation

typedef void*( dtAllocFunc)(int size, dtAllocHint hint)

A memory allocation function.

See also

dtAllocSetCustom

typedef void( dtFreeFunc)(void *ptr)

A memory deallocation function.

Parameters

[in]

ptr

A pointer to a memory block previously allocated using dtAllocFunc.

See also

dtAllocSetCustom

Enumeration Type Documentation

enum dtAllocHint

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

Enumerator
DT_ALLOC_PERM	Memory persist after a function call.
DT_ALLOC_TEMP	Memory used temporarily within a function.

{
 DT_ALLOC_PERM, 
 DT_ALLOC_TEMP 
};

Function Documentation

void* dtAlloc	(	int	size,
		dtAllocHint	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

dtFree

{
 return sAllocFunc(size, hint);
}

Here is the caller graph for this function:

void dtAllocSetCustom	(	dtAllocFunc *	allocFunc,
		dtFreeFunc *	freeFunc
	)

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

Parameters

[in]	allocFunc	The memory allocation function to be used by dtAlloc
[in]	freeFunc	The memory de-allocation function to be used by dtFree

{
 sAllocFunc = allocFunc ? allocFunc : dtAllocDefault;
 sFreeFunc = freeFunc ? freeFunc : dtFreeDefault;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void dtFree

(

void *

ptr

)

Deallocates a memory block.

Parameters

[in]

ptr

A pointer to a memory block previously allocated using dtAlloc.

See also

dtAlloc

{
 if (ptr)
 sFreeFunc(ptr);
}

Here is the caller graph for this function: