From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/group__particles.html | 212 +++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__particles.html') 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 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: particles (deprecated) + + + + + + + +
+

particles (deprecated)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

class  PxParticleBase
 The particle base class represents the shared module for particle based simulation. This class can't be instantiated. (deprecated). More...
struct  PxParticleBaseFlag
 ParticleBase flags (deprecated). More...
class  PxParticleCreationData
 Descriptor-like user-side class describing buffers for particle creation. (deprecated). More...
struct  PxParticleFlag
class  PxParticleFluid
 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 PxParticleBase class and adds particle-particle interactions. More...
class  PxParticleFluidReadData
 Data layout descriptor for reading fluid particle data from the SDK. (deprecated). More...
struct  PxParticleReadDataFlag
class  PxParticleReadData
 Data layout descriptor for reading particle data from the SDK. (deprecated). More...
class  PxParticleSystem
 The particle system class represents the main module for particle based simulation. (deprecated). More...

Typedefs

typedef PX_DEPRECATED PxFlags
+< PxParticleBaseFlag::Enum,
+PxU16 > 		PxParticleBaseFlags
 collection of set bits defined in PxParticleBaseFlag. (deprecated)
typedef PX_DEPRECATED PxFlags
+< PxParticleReadDataFlag::Enum,
+PxU16 > 		PxParticleReadDataFlags
 collection of set bits defined in PxParticleReadDataFlag. (deprecated)
typedef PX_DEPRECATED PxFlags
+< PxParticleFlag::Enum, PxU16 > 		PxParticleFlags
 collection of set bits defined in PxParticleFlag. (deprecated)

Functions

PX_INLINE PxParticleCreationData::PxParticleCreationData ()
 Constructor sets to default.
PX_INLINE void PxParticleCreationData::setToDefault ()
 (Re)sets the structure to the default.
PX_INLINE bool PxParticleCreationData::isValid () const
 Returns true if the current settings are valid.
+

Detailed Description

+

Typedef Documentation

+ +
+
+ + + + +
typedef PX_DEPRECATED PxFlags<PxParticleBaseFlag::Enum, PxU16> PxParticleBaseFlags
+
+
+ +

+collection of set bits defined in PxParticleBaseFlag. (deprecated) +

+

Deprecated:
The PhysX particle feature has been deprecated in PhysX version 3.4
+
See also:
PxParticleBaseFlag
+ +
+

+ +

+
+ + + + +
typedef PX_DEPRECATED PxFlags<PxParticleFlag::Enum, PxU16> PxParticleFlags
+
+
+ +

+collection of set bits defined in PxParticleFlag. (deprecated) +

+

Deprecated:
The PhysX particle feature has been deprecated in PhysX version 3.4
+
See also:
PxParticleFlag
+ +
+

+ +

+
+ + + + +
typedef PX_DEPRECATED PxFlags<PxParticleReadDataFlag::Enum, PxU16> PxParticleReadDataFlags
+
+
+ +

+collection of set bits defined in PxParticleReadDataFlag. (deprecated) +

+

Deprecated:
The PhysX particle feature has been deprecated in PhysX version 3.4
+
See also:
PxParticleReadDataFlag
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + +
PX_INLINE bool PxParticleCreationData::isValid (  )  const [inherited]
+
+
+ +

+Returns true if the current settings are valid. +

+ +

References PxParticleCreationData::indexBuffer, PxParticleCreationData::numParticles, PxParticleCreationData::positionBuffer, and PxStrideIterator< T >::ptr().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE PxParticleCreationData::PxParticleCreationData (  )  [inherited]
+
+
+ +

+Constructor sets to default. +

+ +

References PxParticleCreationData::flagBuffer, PxParticleCreationData::indexBuffer, PxParticleCreationData::positionBuffer, PxParticleCreationData::restOffsetBuffer, and PxParticleCreationData::velocityBuffer.

+ +

Referenced by PxParticleCreationData::setToDefault().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE void PxParticleCreationData::setToDefault (  )  [inherited]
+
+
+ +

+(Re)sets the structure to the default. +

+ +

References PxParticleCreationData::PxParticleCreationData().

+ +
+

+

+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3