Recast Navigation
Navigation-mesh Toolset for Games
Loading...
Searching...
No Matches
DetourAlloc.h
Go to the documentation of this file.
1//
2// Copyright (c) 2009-2010 Mikko Mononen memon@inside.org
3//
4// This software is provided 'as-is', without any express or implied
5// warranty. In no event will the authors be held liable for any damages
6// arising from the use of this software.
7// Permission is granted to anyone to use this software for any purpose,
8// including commercial applications, and to alter it and redistribute it
9// freely, subject to the following restrictions:
10// 1. The origin of this software must not be misrepresented; you must not
11// claim that you wrote the original software. If you use this software
12// in a product, an acknowledgment in the product documentation would be
13// appreciated but is not required.
14// 2. Altered source versions must be plainly marked as such, and must not be
15// misrepresented as being the original software.
16// 3. This notice may not be removed or altered from any source distribution.
17//
18
19#ifndef DETOURALLOCATOR_H
20#define DETOURALLOCATOR_H
21
22#include <stddef.h>
23
31
33// @param[in] size The size, in bytes of memory, to allocate.
34// @param[in] rcAllocHint A hint to the allocator on how long the memory is expected to be in use.
35// @return A pointer to the beginning of the allocated memory block, or null if the allocation failed.
37typedef void* (dtAllocFunc)(size_t size, dtAllocHint hint);
38
42typedef void (dtFreeFunc)(void* ptr);
43
47void dtAllocSetCustom(dtAllocFunc *allocFunc, dtFreeFunc *freeFunc);
48
54void* dtAlloc(size_t size, dtAllocHint hint);
55
59void dtFree(void* ptr);
60
61#endif
void() dtFreeFunc(void *ptr)
A memory deallocation function.
Definition DetourAlloc.h:42
dtAllocHint
Provides hint values to the memory allocator on how long the memory is expected to be used.
Definition DetourAlloc.h:27
@ DT_ALLOC_TEMP
Memory used temporarily within a function.
Definition DetourAlloc.h:29
@ DT_ALLOC_PERM
Memory persist after a function call.
Definition DetourAlloc.h:28
void * dtAlloc(size_t size, dtAllocHint hint)
Allocates a memory block.
Definition DetourAlloc.cpp:41
void *() dtAllocFunc(size_t size, dtAllocHint hint)
A memory allocation function.
Definition DetourAlloc.h:37
void dtFree(void *ptr)
Deallocates a memory block.
Definition DetourAlloc.cpp:46
void dtAllocSetCustom(dtAllocFunc *allocFunc, dtFreeFunc *freeFunc)
Sets the base custom allocation functions to be used by Detour.
Definition DetourAlloc.cpp:35