PxBatchQueryMemory Struct Reference
[Physics]

Struct for PxBatchQuery memory pointers. More...

#include <PxBatchQueryDesc.h>

Collaboration diagram for PxBatchQueryMemory:

[legend]

List of all members.

Public Member Functions
PX_FORCE_INLINE PxU32	getMaxRaycastsPerExecute () const
PX_FORCE_INLINE PxU32	getMaxSweepsPerExecute () const
PX_FORCE_INLINE PxU32	getMaxOverlapsPerExecute () const
	PxBatchQueryMemory (PxU32 raycastResultBufferSize_, PxU32 sweepResultBufferSize_, PxU32 overlapResultBufferSize_)
Public Attributes
PxRaycastQueryResult *	userRaycastResultBuffer
	The pointer to the user-allocated buffer for results of raycast queries in corresponding order of issue.
PxRaycastHit *	userRaycastTouchBuffer
	The pointer to the user-allocated buffer for raycast touch hits.
PxSweepQueryResult *	userSweepResultBuffer
	The pointer to the user-allocated buffer for results of sweep queries in corresponding order of issue.
PxSweepHit *	userSweepTouchBuffer
	The pointer to the user-allocated buffer for sweep hits.
PxOverlapQueryResult *	userOverlapResultBuffer
	The pointer to the user-allocated buffer for results of overlap queries in corresponding order of issue.
PxOverlapHit *	userOverlapTouchBuffer
	The pointer to the user-allocated buffer for overlap hits.
PxU32	raycastTouchBufferSize
	Capacity of the user-allocated userRaycastTouchBuffer in elements.
PxU32	sweepTouchBufferSize
	Capacity of the user-allocated userSweepTouchBuffer in elements.
PxU32	overlapTouchBufferSize
	Capacity of the user-allocated userOverlapTouchBuffer in elements.
Protected Attributes
PxU32	raycastResultBufferSize
PxU32	sweepResultBufferSize
PxU32	overlapResultBufferSize

---

Detailed Description

Struct for PxBatchQuery memory pointers.

Deprecated:

The batched query feature has been deprecated in PhysX version 3.4

See also:

PxBatchQuery PxBatchQueryDesc

---

Constructor & Destructor Documentation

PxBatchQueryMemory::PxBatchQueryMemory	(	PxU32	raycastResultBufferSize_,
		PxU32	sweepResultBufferSize_,
		PxU32	overlapResultBufferSize_
	)			[inline]

---

Member Function Documentation

PX_FORCE_INLINE PxU32 PxBatchQueryMemory::getMaxOverlapsPerExecute

(

)

const [inline]

Returns:

Capacity of the user-allocated userOverlapResultBuffer in elements (max number of overlap() calls before execute() call)

PX_FORCE_INLINE PxU32 PxBatchQueryMemory::getMaxRaycastsPerExecute

(

)

const [inline]

Returns:

Capacity of the user-allocated userRaycastResultBuffer in elements (max number of raycast() calls before execute() call)

PX_FORCE_INLINE PxU32 PxBatchQueryMemory::getMaxSweepsPerExecute

(

)

const [inline]

Returns:

Capacity of the user-allocated userSweepResultBuffer in elements (max number of sweep() calls before execute() call)

---

Member Data Documentation

PxU32 PxBatchQueryMemory::overlapResultBufferSize [protected]

PxU32 PxBatchQueryMemory::overlapTouchBufferSize

Capacity of the user-allocated userOverlapTouchBuffer in elements.

PxU32 PxBatchQueryMemory::raycastResultBufferSize [protected]

PxU32 PxBatchQueryMemory::raycastTouchBufferSize

Capacity of the user-allocated userRaycastTouchBuffer in elements.

PxU32 PxBatchQueryMemory::sweepResultBufferSize [protected]

PxU32 PxBatchQueryMemory::sweepTouchBufferSize

Capacity of the user-allocated userSweepTouchBuffer in elements.

PxOverlapQueryResult* PxBatchQueryMemory::userOverlapResultBuffer

The pointer to the user-allocated buffer for results of overlap queries in corresponding order of issue.

Note:

The size should be large enough to fit the number of expected overlap queries.

See also:

PxRaycastQueryResult

PxOverlapHit* PxBatchQueryMemory::userOverlapTouchBuffer

The pointer to the user-allocated buffer for overlap hits.

Note:

The size of this buffer should be large enough to store the hits returned. If the buffer is too small to store hits, the related PxOverlapQueryResult.queryStatus will be set to eABORTED

PxRaycastQueryResult* PxBatchQueryMemory::userRaycastResultBuffer

The pointer to the user-allocated buffer for results of raycast queries in corresponding order of issue.

Note:

The size should be large enough to fit the number of expected raycast queries.

See also:

PxRaycastQueryResult

PxRaycastHit* PxBatchQueryMemory::userRaycastTouchBuffer

The pointer to the user-allocated buffer for raycast touch hits.

Note:

The size of this buffer should be large enough to store PxRaycastHit. If the buffer is too small to store hits, the related PxRaycastQueryResult.queryStatus will be set to eOVERFLOW

PxSweepQueryResult* PxBatchQueryMemory::userSweepResultBuffer

The pointer to the user-allocated buffer for results of sweep queries in corresponding order of issue.

Note:

The size should be large enough to fit the number of expected sweep queries.

See also:

PxRaycastQueryResult

PxSweepHit* PxBatchQueryMemory::userSweepTouchBuffer

The pointer to the user-allocated buffer for sweep hits.

Note:

The size of this buffer should be large enough to store PxSweepHit. If the buffer is too small to store hits, the related PxSweepQueryResult.queryStatus will be set to eOVERFLOW

---

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

• PxBatchQueryDesc.h