A particle buffer used to simulate diffuse particles. More...

#include <PxParticleBuffer.h>

Inheritance diagram for physx::PxParticleAndDiffuseBuffer:

Collaboration diagram for physx::PxParticleAndDiffuseBuffer:

Public Member Functions
virtual PxVec4 *	getDiffusePositionLifeTime () const =0
	Get a device buffer of positions and remaining lifetimes for the diffuse particles.

virtual PxU32	getNbActiveDiffuseParticles () const =0
	Get number of currently active diffuse particles.

virtual void	setMaxActiveDiffuseParticles (PxU32 maxActiveDiffuseParticles)=0
	Set the maximum possible number of diffuse particles for this buffer.

virtual PxU32	getMaxDiffuseParticles () const =0
	Get maximum possible number of diffuse particles.

virtual void	setDiffuseParticleParams (const PxDiffuseParticleParams &params)=0
	Set the parameters for diffuse particle simulation.

virtual PxDiffuseParticleParams	getDiffuseParticleParams () const =0
	Get the parameters currently used for diffuse particle simulation.

Public Member Functions inherited from physx::PxParticleBuffer
virtual PxVec4 *	getPositionInvMasses () const =0
	Get positions and inverse masses for this particle buffer.

virtual PxVec4 *	getVelocities () const =0
	Get velocities for this particle buffer.

virtual PxU32 *	getPhases () const =0
	Get phases for this particle buffer.

virtual PxParticleVolume *	getParticleVolumes () const =0
	Get particle volumes for this particle buffer.

virtual void	setNbActiveParticles (PxU32 nbActiveParticles)=0
	Set the number of active particles for this particle buffer.

virtual PxU32	getNbActiveParticles () const =0
	Get the number of active particles for this particle buffer.

virtual PxU32	getMaxParticles () const =0
	Get the maximum number particles this particle buffer can hold.

virtual PxU32	getNbParticleVolumes () const =0
	Get the number of particle volumes in this particle buffer.

virtual void	setNbParticleVolumes (PxU32 nbParticleVolumes)=0
	Set the number of #PxParticleVolume s for this particle buffer.

virtual PxU32	getMaxParticleVolumes () const =0
	Get the maximum number of particle volumes this particle buffer can hold.

virtual void	setRigidFilters (PxParticleRigidFilterPair *filters, PxU32 nbFilters)=0
	Set the #PxParticleRigidFilterPair s for collision filtering of particles in this buffer with rigid bodies.

virtual void	setRigidAttachments (PxParticleRigidAttachment *attachments, PxU32 nbAttachments)=0
	Set the particle-rigid body attachments for particles in this particle buffer.

virtual PxU32	getFlatListStartIndex () const =0
	Get the start index for the first particle of this particle buffer in the complete list of particles of the particle system this buffer is used in.

virtual void	raiseFlags (PxParticleBufferFlag::Enum flags)=0
	Raise dirty flags on this particle buffer to communicate that the corresponding data has been updated by the user.

virtual void	release ()=0
	Release this buffer and deallocate all the memory.

virtual void	onParticleSystemDestroy ()=0
	Cleanup helper used in case a particle system is released before the particle buffers have been removed.

virtual void	setInternalData (void *data)=0
	Reserved for internal use.

Public Member Functions inherited from physx::PxBase
virtual const char *	getConcreteTypeName () const =0
	Returns string name of dynamic type.

template<class T >
T *	is ()

template<class T >
const T *	is () const

PX_FORCE_INLINE PxType	getConcreteType () const
	Returns concrete type of object.

PX_FORCE_INLINE void	setBaseFlag (PxBaseFlag::Enum flag, bool value)
	Set PxBaseFlag

PX_FORCE_INLINE void	setBaseFlags (PxBaseFlags inFlags)
	Set PxBaseFlags

PX_FORCE_INLINE PxBaseFlags	getBaseFlags () const
	Returns PxBaseFlags.

virtual bool	isReleasable () const
	Whether the object is subordinate.

Protected Member Functions
PX_INLINE	PxParticleAndDiffuseBuffer (PxU32 uniqueId)

Protected Member Functions inherited from physx::PxParticleBuffer
PX_INLINE	PxParticleBuffer (PxU32 uniqueId)

PX_INLINE	PxParticleBuffer (PxU32 uniqueId, PxType type)

Protected Member Functions inherited from physx::PxBase
PX_INLINE	PxBase (PxType concreteType, PxBaseFlags baseFlags)
	Constructor setting concrete type and base flags.

PX_INLINE	PxBase (PxBaseFlags baseFlags)
	Deserialization constructor setting base flags.

virtual	~PxBase ()
	Destructor.

virtual bool	isKindOf (const char *superClass) const
	Returns whether a given type name matches with the type of this instance.

template<class T >
bool	typeMatch () const

Additional Inherited Members
Public Attributes inherited from physx::PxParticleBuffer
PxU32	bufferIndex
	Index of this buffer in the particle system it is assigned to.

const PxU32	bufferUniqueId
	Unique index that does not change over the lifetime of a PxParticleBuffer.

Protected Attributes inherited from physx::PxBase
PxType	mConcreteType

PxBaseFlags	mBaseFlags

PxU32	mBuiltInRefCount

Detailed Description

A particle buffer used to simulate diffuse particles.

See PxPhysics::createParticleAndDiffuseBuffer.

Member Function Documentation

◆ getDiffuseParticleParams()

virtual PxDiffuseParticleParams physx::PxParticleAndDiffuseBuffer::getDiffuseParticleParams ( ) const

pure virtual

Get the parameters currently used for diffuse particle simulation.

Returns: A PxDiffuseParticleParams structure.

◆ getDiffusePositionLifeTime()

virtual PxVec4 * physx::PxParticleAndDiffuseBuffer::getDiffusePositionLifeTime ( ) const

pure virtual

Get a device buffer of positions and remaining lifetimes for the diffuse particles.

Returns: A device buffer containing positions and lifetimes of diffuse particles packed as PxVec4(pos.x, pos.y, pos.z, lifetime).

◆ getMaxDiffuseParticles()

virtual PxU32 physx::PxParticleAndDiffuseBuffer::getMaxDiffuseParticles ( ) const

pure virtual

Get maximum possible number of diffuse particles.

Returns: The maximum possible number diffuse particles.

◆ getNbActiveDiffuseParticles()

virtual PxU32 physx::PxParticleAndDiffuseBuffer::getNbActiveDiffuseParticles ( ) const

pure virtual

Get number of currently active diffuse particles.

Returns: The number of currently active diffuse particles.

◆ setDiffuseParticleParams()

virtual void physx::PxParticleAndDiffuseBuffer::setDiffuseParticleParams ( const PxDiffuseParticleParams & params )

pure virtual

Set the parameters for diffuse particle simulation.

Parameters

[in] params The diffuse particle parameters.

See #PxDiffuseParticleParams

◆ setMaxActiveDiffuseParticles()

virtual void physx::PxParticleAndDiffuseBuffer::setMaxActiveDiffuseParticles ( PxU32 maxActiveDiffuseParticles )

pure virtual

Set the maximum possible number of diffuse particles for this buffer.

Parameters

[in] maxActiveDiffuseParticles the maximum number of active diffuse particles.

Note: Must be in the range [0, PxParticleAndDiffuseBuffer::getMaxDiffuseParticles()]

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

RavEngine/deps/physx/physx/include/PxParticleBuffer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDiffuseParticleParams()

◆ getDiffusePositionLifeTime()

◆ getMaxDiffuseParticles()

◆ getNbActiveDiffuseParticles()

◆ setDiffuseParticleParams()

◆ setMaxActiveDiffuseParticles()