diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html | 212 |
1 files changed, 212 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html new file mode 100644 index 00000000..79d7c02c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html @@ -0,0 +1,212 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: particles (deprecated)</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="contents"> +<h1>particles (deprecated)</h1><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html">PxParticleBase</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The particle base class represents the shared module for particle based simulation. This class can't be instantiated. (deprecated). <a href="classPxParticleBase.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxParticleBaseFlag.html">PxParticleBaseFlag</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">ParticleBase flags (deprecated). <a href="structPxParticleBaseFlag.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html">PxParticleCreationData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Descriptor-like user-side class describing buffers for particle creation. (deprecated). <a href="classPxParticleCreationData.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxParticleFlag.html">PxParticleFlag</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleFluid.html">PxParticleFluid</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The particle fluid class represents the main module for particle based fluid simulation. (deprecated) SPH (Smoothed Particle Hydrodynamics) is used to animate the particles. This class inherits the properties of the <a class="el" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a> class and adds particle-particle interactions. <a href="classPxParticleFluid.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleFluidReadData.html">PxParticleFluidReadData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Data layout descriptor for reading fluid particle data from the SDK. (deprecated). <a href="classPxParticleFluidReadData.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxParticleReadDataFlag.html">PxParticleReadDataFlag</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleReadData.html">PxParticleReadData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Data layout descriptor for reading particle data from the SDK. (deprecated). <a href="classPxParticleReadData.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html">PxParticleSystem</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The particle system class represents the main module for particle based simulation. (deprecated). <a href="classPxParticleSystem.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxParticleBaseFlag.html#133d603af58af35124b6bea1977b5bc3">PxParticleBaseFlag::Enum</a>, <br class="typebreak"> +PxU16 > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#gd9a0f233df7019b50efb5fa8833610b9">PxParticleBaseFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">collection of set bits defined in <a class="el" href="structPxParticleBaseFlag.html" title="ParticleBase flags (deprecated).">PxParticleBaseFlag</a>. (deprecated) <a href="#gd9a0f233df7019b50efb5fa8833610b9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxParticleReadDataFlag.html#e228980b8744bbaa5c1567a17183ae71">PxParticleReadDataFlag::Enum</a>, <br class="typebreak"> +PxU16 > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248">PxParticleReadDataFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">collection of set bits defined in <a class="el" href="structPxParticleReadDataFlag.html">PxParticleReadDataFlag</a>. (deprecated) <a href="#g7eb9d4fd42d62041395fa34b23f56248"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee28">PxParticleFlag::Enum</a>, PxU16 > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g050377ebb1199554720b6324c5dd340d">PxParticleFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">collection of set bits defined in <a class="el" href="structPxParticleFlag.html">PxParticleFlag</a>. (deprecated) <a href="#g050377ebb1199554720b6324c5dd340d"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g8946abea4ff273cbecd459cd74e83f79">PxParticleCreationData::PxParticleCreationData</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor sets to default. <a href="#g8946abea4ff273cbecd459cd74e83f79"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g565e686111afbbdaf07c2bd8b149efb6">PxParticleCreationData::setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Re)sets the structure to the default. <a href="#g565e686111afbbdaf07c2bd8b149efb6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g4704c9569fda58e36cd791d9b106247b">PxParticleCreationData::isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the current settings are valid. <a href="#g4704c9569fda58e36cd791d9b106247b"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="gd9a0f233df7019b50efb5fa8833610b9"></a><!-- doxytag: member="PxParticleBaseFlag.h::PxParticleBaseFlags" ref="gd9a0f233df7019b50efb5fa8833610b9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxParticleBaseFlag.html#133d603af58af35124b6bea1977b5bc3">PxParticleBaseFlag::Enum</a>, PxU16> <a class="el" href="group__particles.html#gd9a0f233df7019b50efb5fa8833610b9">PxParticleBaseFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +collection of set bits defined in <a class="el" href="structPxParticleBaseFlag.html" title="ParticleBase flags (deprecated).">PxParticleBaseFlag</a>. (deprecated) +<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000053">Deprecated:</a></b></dt><dd>The PhysX particle feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxParticleBaseFlag.html" title="ParticleBase flags (deprecated).">PxParticleBaseFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g050377ebb1199554720b6324c5dd340d"></a><!-- doxytag: member="PxParticleReadData.h::PxParticleFlags" ref="g050377ebb1199554720b6324c5dd340d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee28">PxParticleFlag::Enum</a>, PxU16> <a class="el" href="group__particles.html#g050377ebb1199554720b6324c5dd340d">PxParticleFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +collection of set bits defined in <a class="el" href="structPxParticleFlag.html">PxParticleFlag</a>. (deprecated) +<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000060">Deprecated:</a></b></dt><dd>The PhysX particle feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxParticleFlag.html">PxParticleFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g7eb9d4fd42d62041395fa34b23f56248"></a><!-- doxytag: member="PxParticleReadData.h::PxParticleReadDataFlags" ref="g7eb9d4fd42d62041395fa34b23f56248" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef PX_DEPRECATED <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxParticleReadDataFlag.html#e228980b8744bbaa5c1567a17183ae71">PxParticleReadDataFlag::Enum</a>, PxU16> <a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248">PxParticleReadDataFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +collection of set bits defined in <a class="el" href="structPxParticleReadDataFlag.html">PxParticleReadDataFlag</a>. (deprecated) +<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000059">Deprecated:</a></b></dt><dd>The PhysX particle feature has been deprecated in PhysX version 3.4</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxParticleReadDataFlag.html">PxParticleReadDataFlag</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g4704c9569fda58e36cd791d9b106247b"></a><!-- doxytag: member="PxParticleCreationData::isValid" ref="g4704c9569fda58e36cd791d9b106247b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxParticleCreationData::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the current settings are valid. +<p> + +<p>References <a class="el" href="PxParticleCreationData_8h-source.html#l00070">PxParticleCreationData::indexBuffer</a>, <a class="el" href="PxParticleCreationData_8h-source.html#l00063">PxParticleCreationData::numParticles</a>, <a class="el" href="PxParticleCreationData_8h-source.html#l00077">PxParticleCreationData::positionBuffer</a>, and <a class="el" href="PxStrideIterator_8h-source.html#l00126">PxStrideIterator< T >::ptr()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="g8946abea4ff273cbecd459cd74e83f79"></a><!-- doxytag: member="PxParticleCreationData::PxParticleCreationData" ref="g8946abea4ff273cbecd459cd74e83f79" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxParticleCreationData::PxParticleCreationData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor sets to default. +<p> + +<p>References <a class="el" href="PxParticleCreationData_8h-source.html#l00105">PxParticleCreationData::flagBuffer</a>, <a class="el" href="PxParticleCreationData_8h-source.html#l00070">PxParticleCreationData::indexBuffer</a>, <a class="el" href="PxParticleCreationData_8h-source.html#l00077">PxParticleCreationData::positionBuffer</a>, <a class="el" href="PxParticleCreationData_8h-source.html#l00093">PxParticleCreationData::restOffsetBuffer</a>, and <a class="el" href="PxParticleCreationData_8h-source.html#l00084">PxParticleCreationData::velocityBuffer</a>.</p> + +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00132">PxParticleCreationData::setToDefault()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="g565e686111afbbdaf07c2bd8b149efb6"></a><!-- doxytag: member="PxParticleCreationData::setToDefault" ref="g565e686111afbbdaf07c2bd8b149efb6" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxParticleCreationData::setToDefault </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inherited]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(Re)sets the structure to the default. +<p> + +<p>References <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData::PxParticleCreationData()</a>.</p> + +</div> +</div><p> +</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> |