Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-29 22:48:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
recastnavigation/RecastAlloc_8cpp.html

354 lines
18 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: RecastAlloc.cpp File Reference</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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('RecastAlloc_8cpp.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">RecastAlloc.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="RecastAlloc_8h_source.html">RecastAlloc.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a103114f4a1be2bb85eb0da390a0b11f8" id="r_a103114f4a1be2bb85eb0da390a0b11f8"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#a103114f4a1be2bb85eb0da390a0b11f8">rcAllocDefault</a> (size_t size, <a class="el" href="RecastAlloc_8h.html#a1e8b4a818c5bf25bceae59a0b1857e60">rcAllocHint</a>)</td></tr>
<tr class="separator:a103114f4a1be2bb85eb0da390a0b11f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0145e00a43b3248ba49fda410573128f" id="r_a0145e00a43b3248ba49fda410573128f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#a0145e00a43b3248ba49fda410573128f">rcFreeDefault</a> (void *ptr)</td></tr>
<tr class="separator:a0145e00a43b3248ba49fda410573128f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3f9da3566ad0877b9e4c9e92f8e1a15" id="r_ae3f9da3566ad0877b9e4c9e92f8e1a15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#ae3f9da3566ad0877b9e4c9e92f8e1a15">rcAllocSetCustom</a> (<a class="el" href="RecastAlloc_8h.html#aac6c154ba81182fb0e6d7ea83d03e541">rcAllocFunc</a> *allocFunc, <a class="el" href="RecastAlloc_8h.html#a4b9eeb5aeec74bff1afc64fdf8e72764">rcFreeFunc</a> *freeFunc)</td></tr>
<tr class="memdesc:ae3f9da3566ad0877b9e4c9e92f8e1a15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the base custom allocation functions to be used by Recast. <br /></td></tr>
<tr class="separator:ae3f9da3566ad0877b9e4c9e92f8e1a15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23d42b8202457d252efde3042cac102a" id="r_a23d42b8202457d252efde3042cac102a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#a23d42b8202457d252efde3042cac102a">rcAlloc</a> (size_t size, <a class="el" href="RecastAlloc_8h.html#a1e8b4a818c5bf25bceae59a0b1857e60">rcAllocHint</a> hint)</td></tr>
<tr class="memdesc:a23d42b8202457d252efde3042cac102a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates a memory block. <br /></td></tr>
<tr class="separator:a23d42b8202457d252efde3042cac102a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fc4cfee655e24f94bad226f915ac397" id="r_a6fc4cfee655e24f94bad226f915ac397"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#a6fc4cfee655e24f94bad226f915ac397">rcFree</a> (void *ptr)</td></tr>
<tr class="memdesc:a6fc4cfee655e24f94bad226f915ac397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocates a memory block. <br /></td></tr>
<tr class="separator:a6fc4cfee655e24f94bad226f915ac397"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:af1b06b448acf4005967583e7dc905a66" id="r_af1b06b448acf4005967583e7dc905a66"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="RecastAlloc_8h.html#aac6c154ba81182fb0e6d7ea83d03e541">rcAllocFunc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#af1b06b448acf4005967583e7dc905a66">sRecastAllocFunc</a> = <a class="el" href="RecastAlloc_8cpp.html#a103114f4a1be2bb85eb0da390a0b11f8">rcAllocDefault</a></td></tr>
<tr class="separator:af1b06b448acf4005967583e7dc905a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64d9d48dc6a273593cf8034ab2e303de" id="r_a64d9d48dc6a273593cf8034ab2e303de"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="RecastAlloc_8h.html#a4b9eeb5aeec74bff1afc64fdf8e72764">rcFreeFunc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="RecastAlloc_8cpp.html#a64d9d48dc6a273593cf8034ab2e303de">sRecastFreeFunc</a> = <a class="el" href="RecastAlloc_8cpp.html#a0145e00a43b3248ba49fda410573128f">rcFreeDefault</a></td></tr>
<tr class="separator:a64d9d48dc6a273593cf8034ab2e303de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a23d42b8202457d252efde3042cac102a" name="a23d42b8202457d252efde3042cac102a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23d42b8202457d252efde3042cac102a">&#9670;&#160;</a></span>rcAlloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * rcAlloc </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="RecastAlloc_8h.html#a1e8b4a818c5bf25bceae59a0b1857e60">rcAllocHint</a>&#160;</td>
<td class="paramname"><em>hint</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a memory block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size, in bytes of memory, to allocate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hint</td><td>A hint to the allocator on how long the memory is expected to be in use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the beginning of the allocated memory block, or null if the allocation failed. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="RecastAlloc_8h.html#a6fc4cfee655e24f94bad226f915ac397" title="Deallocates a memory block.">rcFree</a>, <a class="el" href="RecastAlloc_8h.html#ae3f9da3566ad0877b9e4c9e92f8e1a15" title="Sets the base custom allocation functions to be used by Recast.">rcAllocSetCustom</a> </dd></dl>
</div>
</div>
<a id="a103114f4a1be2bb85eb0da390a0b11f8" name="a103114f4a1be2bb85eb0da390a0b11f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a103114f4a1be2bb85eb0da390a0b11f8">&#9670;&#160;</a></span>rcAllocDefault()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void * rcAllocDefault </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="RecastAlloc_8h.html#a1e8b4a818c5bf25bceae59a0b1857e60">rcAllocHint</a>&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae3f9da3566ad0877b9e4c9e92f8e1a15" name="ae3f9da3566ad0877b9e4c9e92f8e1a15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3f9da3566ad0877b9e4c9e92f8e1a15">&#9670;&#160;</a></span>rcAllocSetCustom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rcAllocSetCustom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="RecastAlloc_8h.html#aac6c154ba81182fb0e6d7ea83d03e541">rcAllocFunc</a> *&#160;</td>
<td class="paramname"><em>allocFunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="RecastAlloc_8h.html#a4b9eeb5aeec74bff1afc64fdf8e72764">rcFreeFunc</a> *&#160;</td>
<td class="paramname"><em>freeFunc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the base custom allocation functions to be used by Recast. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">allocFunc</td><td>The memory allocation function to be used by <a class="el" href="RecastAlloc_8h.html#a23d42b8202457d252efde3042cac102a" title="Allocates a memory block.">rcAlloc</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">freeFunc</td><td>The memory de-allocation function to be used by <a class="el" href="RecastAlloc_8h.html#a6fc4cfee655e24f94bad226f915ac397" title="Deallocates a memory block.">rcFree</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="RecastAlloc_8h.html#a23d42b8202457d252efde3042cac102a" title="Allocates a memory block.">rcAlloc</a>, <a class="el" href="RecastAlloc_8h.html#a6fc4cfee655e24f94bad226f915ac397" title="Deallocates a memory block.">rcFree</a> </dd></dl>
</div>
</div>
<a id="a6fc4cfee655e24f94bad226f915ac397" name="a6fc4cfee655e24f94bad226f915ac397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fc4cfee655e24f94bad226f915ac397">&#9670;&#160;</a></span>rcFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rcFree </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deallocates a memory block. </p>
<p>If <code>ptr</code> is NULL, this does nothing. </p><dl class="section warning"><dt>Warning</dt><dd>This function leaves the value of <code>ptr</code> unchanged. So it still points to the same (now invalid) location, and not to null. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>A pointer to a memory block previously allocated using <a class="el" href="RecastAlloc_8h.html#a23d42b8202457d252efde3042cac102a" title="Allocates a memory block.">rcAlloc</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="RecastAlloc_8h.html#a23d42b8202457d252efde3042cac102a" title="Allocates a memory block.">rcAlloc</a>, <a class="el" href="RecastAlloc_8h.html#ae3f9da3566ad0877b9e4c9e92f8e1a15" title="Sets the base custom allocation functions to be used by Recast.">rcAllocSetCustom</a> </dd></dl>
</div>
</div>
<a id="a0145e00a43b3248ba49fda410573128f" name="a0145e00a43b3248ba49fda410573128f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0145e00a43b3248ba49fda410573128f">&#9670;&#160;</a></span>rcFreeDefault()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void rcFreeDefault </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="af1b06b448acf4005967583e7dc905a66" name="af1b06b448acf4005967583e7dc905a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1b06b448acf4005967583e7dc905a66">&#9670;&#160;</a></span>sRecastAllocFunc</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="RecastAlloc_8h.html#aac6c154ba81182fb0e6d7ea83d03e541">rcAllocFunc</a>* sRecastAllocFunc = <a class="el" href="RecastAlloc_8cpp.html#a103114f4a1be2bb85eb0da390a0b11f8">rcAllocDefault</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a64d9d48dc6a273593cf8034ab2e303de" name="a64d9d48dc6a273593cf8034ab2e303de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64d9d48dc6a273593cf8034ab2e303de">&#9670;&#160;</a></span>sRecastFreeFunc</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="RecastAlloc_8h.html#a4b9eeb5aeec74bff1afc64fdf8e72764">rcFreeFunc</a>* sRecastFreeFunc = <a class="el" href="RecastAlloc_8cpp.html#a0145e00a43b3248ba49fda410573128f">rcFreeDefault</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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_e6cf54c9d4d29ff4a28752d861cf44fa.html">Recast</a></li><li class="navelem"><a class="el" href="dir_fe7f4084ac0458032f1df717ceae8313.html">Source</a></li><li class="navelem"><a class="el" href="RecastAlloc_8cpp.html">RecastAlloc.cpp</a></li>
&nbsp;&nbsp;<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>
Reference in New Issue View Git Blame Copy Permalink