dev0/PhysX4.1
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
PhysX4.1/physx/documentation/PhysXAPI/files/classPxDefaultAllocator.html
dev0 a3a8e79709 Init
2025-11-28 23:13:44 +05:30

250 lines
13 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxDefaultAllocator Class 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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" />
</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="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxDefaultAllocator.html','');});
/* @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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classPxDefaultAllocator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxDefaultAllocator Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>default implementation of the allocator interface required by the SDK
<a href="classPxDefaultAllocator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxDefaultAllocator_8h_source.html">PxDefaultAllocator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxDefaultAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classPxDefaultAllocator__inherit__graph.png" border="0" usemap="#PxDefaultAllocator_inherit__map" alt="Inheritance graph"/></div>
<map name="PxDefaultAllocator_inherit__map" id="PxDefaultAllocator_inherit__map">
<area shape="rect" id="node2" href="classPxAllocatorCallback.html" title="Abstract base class for an application defined memory allocator that can be used by the Nv library..." alt="" coords="5,5,144,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxDefaultAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classPxDefaultAllocator__coll__graph.png" border="0" usemap="#PxDefaultAllocator_coll__map" alt="Collaboration graph"/></div>
<map name="PxDefaultAllocator_coll__map" id="PxDefaultAllocator_coll__map">
<area shape="rect" id="node2" href="classPxAllocatorCallback.html" title="Abstract base class for an application defined memory allocator that can be used by the Nv library..." alt="" coords="5,5,144,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acaee20fa98b003bde01d690cbccc2c33"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultAllocator.html#acaee20fa98b003bde01d690cbccc2c33">allocate</a> (size_t size, const char *, const char *, int)</td></tr>
<tr class="memdesc:acaee20fa98b003bde01d690cbccc2c33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates size bytes of memory, which must be 16-byte aligned. <a href="#acaee20fa98b003bde01d690cbccc2c33">More...</a><br /></td></tr>
<tr class="separator:acaee20fa98b003bde01d690cbccc2c33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73221f0158b7740403cd922dca5408fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultAllocator.html#a73221f0158b7740403cd922dca5408fd">deallocate</a> (void *ptr)</td></tr>
<tr class="memdesc:a73221f0158b7740403cd922dca5408fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees memory previously allocated by <a class="el" href="classPxDefaultAllocator.html#acaee20fa98b003bde01d690cbccc2c33" title="Allocates size bytes of memory, which must be 16-byte aligned. ">allocate()</a>. <a href="#a73221f0158b7740403cd922dca5408fd">More...</a><br /></td></tr>
<tr class="separator:a73221f0158b7740403cd922dca5408fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxAllocatorCallback"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxAllocatorCallback')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a></td></tr>
<tr class="memitem:a829ee0db96f23c14e13f4692edba9095 inherit pub_methods_classPxAllocatorCallback"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxAllocatorCallback.html#a829ee0db96f23c14e13f4692edba9095">~PxAllocatorCallback</a> ()</td></tr>
<tr class="memdesc:a829ee0db96f23c14e13f4692edba9095 inherit pub_methods_classPxAllocatorCallback"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="classPxAllocatorCallback.html#a829ee0db96f23c14e13f4692edba9095">More...</a><br /></td></tr>
<tr class="separator:a829ee0db96f23c14e13f4692edba9095 inherit pub_methods_classPxAllocatorCallback"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>default implementation of the allocator interface required by the SDK </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acaee20fa98b003bde01d690cbccc2c33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaee20fa98b003bde01d690cbccc2c33">&#9670;&nbsp;</a></span>allocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* PxDefaultAllocator::allocate </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">const char *&#160;</td>
<td class="paramname"><em>typeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>line</em>&#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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates size bytes of memory, which must be 16-byte aligned. </p>
<p>This method should never return NULL. If you run out of memory, then you should terminate the app or take some other appropriate action.</p>
<p><b>Threading:</b> This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Number of bytes to allocate. </td></tr>
<tr><td class="paramname">typeName</td><td>Name of the datatype that is being allocated </td></tr>
<tr><td class="paramname">filename</td><td>The source file which allocated the memory </td></tr>
<tr><td class="paramname">line</td><td>The source line which allocated the memory </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The allocated block of memory. </dd></dl>
<p>Implements <a class="el" href="classPxAllocatorCallback.html#a7bb2dde434cf541a556b40b31661da29">PxAllocatorCallback</a>.</p>
<p class="reference">References <a class="el" href="group__extensions.html#gad874c3dcee0d1f3ec91e1880a1f09582">platformAlignedAlloc()</a>, and <a class="el" href="group__foundation.html#ga4a83a657390b324a460f14684e5accee">PX_ASSERT</a>.</p>
</div>
</div>
<a id="a73221f0158b7740403cd922dca5408fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73221f0158b7740403cd922dca5408fd">&#9670;&nbsp;</a></span>deallocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PxDefaultAllocator::deallocate </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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees memory previously allocated by <a class="el" href="classPxDefaultAllocator.html#acaee20fa98b003bde01d690cbccc2c33" title="Allocates size bytes of memory, which must be 16-byte aligned. ">allocate()</a>. </p>
<p><b>Threading:</b> This function should be thread safe as it can be called in the context of the user thread and physics processing thread(s).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>Memory to free. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classPxAllocatorCallback.html#a6af8b56b5a786150796b9854d16fde38">PxAllocatorCallback</a>.</p>
<p class="reference">References <a class="el" href="group__extensions.html#gaea2576f54650c42280d79ce79ea1979a">platformAlignedFree()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxDefaultAllocator_8h_source.html">PxDefaultAllocator.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPxDefaultAllocator.html">PxDefaultAllocator</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink