PxParticleExt::PxParticleExt::IndexPool Class Reference

Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An PxParticleExt::IndexPool instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with PxParticleExt::createIndexPool(). More...

#include <PxParticleExt.h>

List of all members.

Public Member Functions
virtual PxU32	allocateIndices (PxU32 num, const PxStrideIterator< PxU32 > &indexBuffer)=0
	Allocates a requested number of indices if possible.
virtual void	freeIndices (PxU32 num, const PxStrideIterator< const PxU32 > &indexBuffer)=0
	Deallocates a requested number of indices.
virtual void	freeIndices ()=0
	Deallocates all previously allocated indices.
virtual void	release ()=0
	Releases IndexPool instance.
virtual	~IndexPool ()
	virtual destructor

---

Detailed Description

Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An PxParticleExt::IndexPool instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with PxParticleExt::createIndexPool().

See also:

PxParticleExt::createIndexPool()

---

Constructor & Destructor Documentation

virtual PxParticleExt::PxParticleExt::IndexPool::~IndexPool

(

)

[inline, virtual]

virtual destructor

---

Member Function Documentation

virtual PxU32 PxParticleExt::PxParticleExt::IndexPool::allocateIndices	(	PxU32	num,
		const PxStrideIterator< PxU32 > &	indexBuffer
	)			[pure virtual]

Allocates a requested number of indices if possible.

Parameters:

[in]	num	Number of indices that should be allocated.
[out]	indexBuffer	Strided data to which allocated indices are written.

Returns:

PxU32. Number of indices that where allocated by the operation.

virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices

(

)

[pure virtual]

Deallocates all previously allocated indices.

virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices	(	PxU32	num,
		const PxStrideIterator< const PxU32 > &	indexBuffer
	)			[pure virtual]

Deallocates a requested number of indices.

Parameters:

[in]	num	Number of indices that should be freed.
[in]	indexBuffer	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()

virtual void PxParticleExt::PxParticleExt::IndexPool::release

(

)

[pure virtual]

Releases IndexPool instance.

---

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

• PxParticleExt.h