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] --- .../files/classPxParticleCreationData.html | 202 +++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html new file mode 100644 index 00000000..c52249b5 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html @@ -0,0 +1,202 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleCreationData Class Reference + + + + + + + +
+

PxParticleCreationData Class Reference
+ +[particles (deprecated)] +

Descriptor-like user-side class describing buffers for particle creation. (deprecated). +More... +

+#include <PxParticleCreationData.h> +

+

+Collaboration diagram for PxParticleCreationData:
+
+

Collaboration graph
+ +PxStrideIterator\< const PxF32 \>PxStrideIterator\< const PxU32 \>PxStrideIterator\< const PxVec3 \>PxVec3 +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

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

Public Attributes

PxU32 numParticles
 The number of particles stored in the buffer.
PxStrideIterator< const PxU32 > indexBuffer
 Particle index data.
PxStrideIterator< const PxVec3 > positionBuffer
 Particle position data.
PxStrideIterator< const PxVec3 > velocityBuffer
 Particle velocity data.
PxStrideIterator< const PxF32 > restOffsetBuffer
 Particle rest offset data.
PxStrideIterator< const PxU32 > flagBuffer
 Particle flags.
+

Detailed Description

+Descriptor-like user-side class describing buffers for particle creation. (deprecated). +

+PxParticleCreationData is used to create particles within the SDK. The SDK copies the particle data referenced by PxParticleCreationData, it may therefore be deallocated right after the creation call returned.

+

Deprecated:
The PhysX particle feature has been deprecated in PhysX version 3.4
+
See also:
PxParticleBase::createParticles()
+

Member Data Documentation

+ +
+
+ + + + +
PxStrideIterator<const PxU32> PxParticleCreationData::flagBuffer
+
+
+ +

+Particle flags. +

+PxParticleFlag.eVALID, PxParticleFlag.eCOLLISION_WITH_STATIC, PxParticleFlag.eCOLLISION_WITH_DYNAMIC, PxParticleFlag.eCOLLISION_WITH_DRAIN, PxParticleFlag.eSPATIAL_DATA_STRUCTURE_OVERFLOW are all flags that can't be set on particle creation. They are written by the SDK exclusively.

+Providing flag data is optional.

See also:
PxParticleFlag
+ +

Referenced by PxParticleCreationData().

+ +
+

+ +

+
+ + + + +
PxStrideIterator<const PxU32> PxParticleCreationData::indexBuffer
+
+
+ +

+Particle index data. +

+When creating particles, providing the particle indices is mandatory. +

Referenced by isValid(), and PxParticleCreationData().

+ +
+

+ +

+
+ + + + +
PxU32 PxParticleCreationData::numParticles
+
+
+ +

+The number of particles stored in the buffer. +

+ +

Referenced by isValid().

+ +
+

+ +

+
+ + + + +
PxStrideIterator<const PxVec3> PxParticleCreationData::positionBuffer
+
+
+ +

+Particle position data. +

+When creating particles, providing the particle positions is mandatory. +

Referenced by isValid(), and PxParticleCreationData().

+ +
+

+ +

+
+ + + + +
PxStrideIterator<const PxF32> PxParticleCreationData::restOffsetBuffer
+
+
+ +

+Particle rest offset data. +

+Values need to be in the range [0.0f, restOffset]. If PxParticleBaseFlag.ePER_PARTICLE_REST_OFFSET is set, providing per particle rest offset data is mandatory.

See also:
PxParticleBaseFlag.ePER_PARTICLE_REST_OFFSET.
+ +

Referenced by PxParticleCreationData().

+ +
+

+ +

+
+ + + + +
PxStrideIterator<const PxVec3> PxParticleCreationData::velocityBuffer
+
+
+ +

+Particle velocity data. +

+Providing velocity data is optional. +

Referenced by PxParticleCreationData().

+ +
+

+

The documentation for this class was generated from the following file: +
+ +

+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