mirror of
https://github.com/recastnavigation/recastnavigation.git
synced 2026-08-31 07:28:48 +00:00
156 lines
15 KiB
HTML
156 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Recast Navigation: DetourAlloc.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Recast Navigation
|
|
</div>
|
|
<div id="projectbrief">Navigation-mesh Toolset for Games</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('DetourAlloc_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">DetourAlloc.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="DetourAlloc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright (c) 2009-2010 Mikko Mononen memon@inside.org</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// This software is provided 'as-is', without any express or implied</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// warranty. In no event will the authors be held liable for any damages</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// arising from the use of this software.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// including commercial applications, and to alter it and redistribute it</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// freely, subject to the following restrictions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// 1. The origin of this software must not be misrepresented; you must not</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// claim that you wrote the original software. If you use this software</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// in a product, an acknowledgment in the product documentation would be</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// appreciated but is not required.</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// 2. Altered source versions must be plainly marked as such, and must not be</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// misrepresented as being the original software.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef DETOURALLOCATOR_H</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define DETOURALLOCATOR_H</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <stddef.h></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14d"> 26</a></span> <span class="keyword">enum</span> <a class="code" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14d">dtAllocHint</a></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da4b5dc5bf08bcea4978a84327c7faf39f"> 28</a></span>  <a class="code" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da4b5dc5bf08bcea4978a84327c7faf39f">DT_ALLOC_PERM</a>, </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da345c28489f1d9c43bb8d528b4dab5aee">DT_ALLOC_TEMP</a> </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da345c28489f1d9c43bb8d528b4dab5aee"> 30</a></span> };</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// @param[in] size The size, in bytes of memory, to allocate.</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// @param[in] rcAllocHint A hint to the allocator on how long the memory is expected to be in use.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// @return A pointer to the beginning of the allocated memory block, or null if the allocation failed.</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="DetourAlloc_8h.html#a5ff0ad0a4309278f973feae6c4193a3c"> 37</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keywordtype">void</span>* (<a class="code" href="DetourAlloc_8h.html#a5ff0ad0a4309278f973feae6c4193a3c">dtAllocFunc</a>)(<span class="keywordtype">size_t</span> size, <a class="code" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14d">dtAllocHint</a> hint);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="DetourAlloc_8h.html#a15d9afa65e6a83a6188c7efa3fa50376"> 42</a></span> <span class="keyword">typedef</span> void (<a class="code" href="DetourAlloc_8h.html#a15d9afa65e6a83a6188c7efa3fa50376">dtFreeFunc</a>)(<span class="keywordtype">void</span>* ptr);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> <a class="code" href="DetourAlloc_8h.html#af867be65f8ee4fcdcabd89cca01f2f4a">dtAllocSetCustom</a>(<a class="code" href="DetourAlloc_8h.html#a5ff0ad0a4309278f973feae6c4193a3c">dtAllocFunc</a> *allocFunc, <a class="code" href="DetourAlloc_8h.html#a15d9afa65e6a83a6188c7efa3fa50376">dtFreeFunc</a> *freeFunc);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span>* <a class="code" href="DetourAlloc_8h.html#ac7a1c461b037f7cc0cd1b2e480d12920">dtAlloc</a>(<span class="keywordtype">size_t</span> size, <a class="code" href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14d">dtAllocHint</a> hint);</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">void</span> <a class="code" href="DetourAlloc_8h.html#adb7919ae2642d1a487ce5fce6ae3af0d">dtFree</a>(<span class="keywordtype">void</span>* ptr);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_a15d9afa65e6a83a6188c7efa3fa50376"><div class="ttname"><a href="DetourAlloc_8h.html#a15d9afa65e6a83a6188c7efa3fa50376">dtFreeFunc</a></div><div class="ttdeci">void() dtFreeFunc(void *ptr)</div><div class="ttdoc">A memory deallocation function.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.h:42</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_a318bc084ec7fefd878cd36e0846bd14d"><div class="ttname"><a href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14d">dtAllocHint</a></div><div class="ttdeci">dtAllocHint</div><div class="ttdoc">Provides hint values to the memory allocator on how long the memory is expected to be used.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.h:27</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_a318bc084ec7fefd878cd36e0846bd14da345c28489f1d9c43bb8d528b4dab5aee"><div class="ttname"><a href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da345c28489f1d9c43bb8d528b4dab5aee">DT_ALLOC_TEMP</a></div><div class="ttdeci">@ DT_ALLOC_TEMP</div><div class="ttdoc">Memory used temporarily within a function.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.h:29</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_a318bc084ec7fefd878cd36e0846bd14da4b5dc5bf08bcea4978a84327c7faf39f"><div class="ttname"><a href="DetourAlloc_8h.html#a318bc084ec7fefd878cd36e0846bd14da4b5dc5bf08bcea4978a84327c7faf39f">DT_ALLOC_PERM</a></div><div class="ttdeci">@ DT_ALLOC_PERM</div><div class="ttdoc">Memory persist after a function call.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.h:28</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_a5ff0ad0a4309278f973feae6c4193a3c"><div class="ttname"><a href="DetourAlloc_8h.html#a5ff0ad0a4309278f973feae6c4193a3c">dtAllocFunc</a></div><div class="ttdeci">void *() dtAllocFunc(size_t size, dtAllocHint hint)</div><div class="ttdoc">A memory allocation function.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.h:37</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_ac7a1c461b037f7cc0cd1b2e480d12920"><div class="ttname"><a href="DetourAlloc_8h.html#ac7a1c461b037f7cc0cd1b2e480d12920">dtAlloc</a></div><div class="ttdeci">void * dtAlloc(size_t size, dtAllocHint hint)</div><div class="ttdoc">Allocates a memory block.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.cpp:41</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_adb7919ae2642d1a487ce5fce6ae3af0d"><div class="ttname"><a href="DetourAlloc_8h.html#adb7919ae2642d1a487ce5fce6ae3af0d">dtFree</a></div><div class="ttdeci">void dtFree(void *ptr)</div><div class="ttdoc">Deallocates a memory block.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.cpp:46</div></div>
|
|
<div class="ttc" id="aDetourAlloc_8h_html_af867be65f8ee4fcdcabd89cca01f2f4a"><div class="ttname"><a href="DetourAlloc_8h.html#af867be65f8ee4fcdcabd89cca01f2f4a">dtAllocSetCustom</a></div><div class="ttdeci">void dtAllocSetCustom(dtAllocFunc *allocFunc, dtFreeFunc *freeFunc)</div><div class="ttdoc">Sets the base custom allocation functions to be used by Detour.</div><div class="ttdef"><b>Definition:</b> DetourAlloc.cpp:35</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.6-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_49bbc5a28a7ee729bdecc682ba5a63c9.html">Detour</a></li><li class="navelem"><a class="el" href="dir_97c6bac6df0065e0578eb2a70aa0bb50.html">Include</a></li><li class="navelem"><a class="el" href="DetourAlloc_8h.html">DetourAlloc.h</a></li>
|
|
<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
|
|
| <a href="./License.txt">Licence (ZLib)</a>
|
|
| Copyright 2009 Mikko Mononen
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|