diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleExt_1_1IndexPool.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleExt_1_1IndexPool.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleExt_1_1IndexPool.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleExt_1_1IndexPool.html new file mode 100644 index 00000000..2c137435 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleExt_1_1IndexPool.html @@ -0,0 +1,201 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleExt::PxParticleExt::IndexPool Class Reference</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="images/PhysXlogo.png" align="middle"> <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> + <div class="navpath"><a class="el" href="classPxParticleExt.html">PxParticleExt</a>::<a class="el" href="classPxParticleExt_1_1IndexPool.html">IndexPool</a> + </div> +<div class="contents"> +<h1>PxParticleExt::PxParticleExt::IndexPool Class Reference</h1><!-- doxytag: class="PxParticleExt::IndexPool" -->Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">PxParticleExt::IndexPool</a> instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with <a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxParticleExt_8h-source.html">PxParticleExt.h</a>></code> +<p> + +<p> +<a href="classPxParticleExt_1_1IndexPool-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#a8925253f6aba703d7ee7fa9c78ef5bb">allocateIndices</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> num, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates a requested number of indices if possible. <a href="#a8925253f6aba703d7ee7fa9c78ef5bb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#337a192c7148f0065865809e27797def">freeIndices</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> num, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates a requested number of indices. <a href="#337a192c7148f0065865809e27797def"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#c8c3dd06ac3fdf8129d1f32f763c99d7">freeIndices</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates all previously allocated indices. <a href="#c8c3dd06ac3fdf8129d1f32f763c99d7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#0f3a38f3fa80a619cdf934349b4d2f79">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">IndexPool</a> instance. <a href="#0f3a38f3fa80a619cdf934349b4d2f79"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#caa320043604a6cdf87803719e7ea193">~IndexPool</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <a href="#caa320043604a6cdf87803719e7ea193"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">PxParticleExt::IndexPool</a> instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with <a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a>. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="caa320043604a6cdf87803719e7ea193"></a><!-- doxytag: member="PxParticleExt::IndexPool::~IndexPool" ref="caa320043604a6cdf87803719e7ea193" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxParticleExt::PxParticleExt::IndexPool::~IndexPool </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +virtual destructor +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="a8925253f6aba703d7ee7fa9c78ef5bb"></a><!-- doxytag: member="PxParticleExt::IndexPool::allocateIndices" ref="a8925253f6aba703d7ee7fa9c78ef5bb" args="(PxU32 num, const PxStrideIterator< PxU32 > &indexBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxParticleExt::PxParticleExt::IndexPool::allocateIndices </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>num</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allocates a requested number of indices if possible. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>num</em> </td><td>Number of indices that should be allocated. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>indexBuffer</em> </td><td>Strided data to which allocated indices are written. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>PxU32. Number of indices that where allocated by the operation. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c8c3dd06ac3fdf8129d1f32f763c99d7"></a><!-- doxytag: member="PxParticleExt::IndexPool::freeIndices" ref="c8c3dd06ac3fdf8129d1f32f763c99d7" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deallocates all previously allocated indices. +<p> + +</div> +</div><p> +<a class="anchor" name="337a192c7148f0065865809e27797def"></a><!-- doxytag: member="PxParticleExt::IndexPool::freeIndices" ref="337a192c7148f0065865809e27797def" args="(PxU32 num, const PxStrideIterator< const PxU32 > &indexBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>num</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deallocates a requested number of indices. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>num</em> </td><td>Number of indices that should be freed. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>indexBuffer</em> </td><td>Strided data describing the indices that need to be freed. It's a requirement to specify unique indices, that where previously allocated by PxParticlesExt::allocateIndices() </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="0f3a38f3fa80a619cdf934349b4d2f79"></a><!-- doxytag: member="PxParticleExt::IndexPool::release" ref="0f3a38f3fa80a619cdf934349b4d2f79" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">IndexPool</a> instance. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxParticleExt_8h-source.html">PxParticleExt.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</body> +</html> |