PxBatchQueryDesc Class Reference

Descriptor class for PxBatchQuery. More...

#include <PxBatchQueryDesc.h>

Collaboration diagram for PxBatchQueryDesc:

Public Member Functions
PX_INLINE	PxBatchQueryDesc (PxU32 maxRaycastsPerExecute, PxU32 maxSweepsPerExecute, PxU32 maxOverlapsPerExecute)
	Construct a batch query with specified maximum number of queries per batch. More...
PX_INLINE bool	isValid () const

Public Attributes
void *	filterShaderData
	Shared global filter data which will get passed into the filter shader. More...
PxU32	filterShaderDataSize
	Size (in bytes) of the shared global filter data filterShaderData. More...
PxBatchQueryPreFilterShader	preFilterShader
	The custom preFilter shader to use for filtering. More...
PxBatchQueryPostFilterShader	postFilterShader
	The custom postFilter shader to use for filtering. More...
void *	spuPreFilterShader
	The custom spu pre filter shader to use for collision filtering. More...
PxU32	spuPreFilterShaderSize
	Size (in bytes) of the spu pre filter shader codes spuPreFilterShader. More...
void *	spuPostFilterShader
	The custom spu post filter shader to use for collision filtering. More...
PxU32	spuPostFilterShaderSize
	Size (in bytes) of the spu post filter shader codes spuPostFilterShader. More...
PxClientID	ownerClient
	client that creates and owns this scene query. More...
PxBatchQueryMemory	queryMemory
	User memory buffers for the query. More...
bool	runOnSpu
	PS3 only. Enables or disables SPU execution for this batch. More...

Detailed Description

Descriptor class for PxBatchQuery.

See Also

PxBatchQuery PxSceneQueryExecuteMode

Member Data Documentation

void* PxBatchQueryDesc::filterShaderData

Shared global filter data which will get passed into the filter shader.

Note

The provided data will get copied to internal buffers and this copy will be used for filtering calls.

Default: NULL

See Also

PxSimulationFilterShader

Referenced by isValid().

PxU32 PxBatchQueryDesc::filterShaderDataSize

Size (in bytes) of the shared global filter data filterShaderData.

Default: 0

See Also

PxSimulationFilterShader filterShaderData

Referenced by isValid().

PxClientID PxBatchQueryDesc::ownerClient

client that creates and owns this scene query.

This value will be used as an override when PX_DEFAULT_CLIENT value is passed to the query in PxQueryFilterData.clientId.

See Also

PxScene::createClient()

PxBatchQueryPostFilterShader PxBatchQueryDesc::postFilterShader

The custom postFilter shader to use for filtering.

See Also

PxBatchQueryPostFilterShader PxDefaultPostFilterShader

Referenced by isValid().

PxBatchQueryPreFilterShader PxBatchQueryDesc::preFilterShader

The custom preFilter shader to use for filtering.

See Also

PxBatchQueryPreFilterShader PxDefaultPreFilterShader

Referenced by isValid().

PxBatchQueryMemory PxBatchQueryDesc::queryMemory

User memory buffers for the query.

See Also

PxBatchQueryMemory

bool PxBatchQueryDesc::runOnSpu

PS3 only. Enables or disables SPU execution for this batch.

Defaults to true on PS3, ignored on other platforms.

void* PxBatchQueryDesc::spuPostFilterShader

The custom spu post filter shader to use for collision filtering.

Note

This parameter is a fragment of SPU binary codes with the similar function of PxBatchQueryPostFilterShader. The requirement of the spu function is the same as PxBatchQueryPreFilterShader::filter. To compile the shader for spu, you can reference the implementation, PreBuild configuration in the project file of SampleVehicle.If you don't want to define your own filter shader you can just leave this variable as NULL. library.

Platform specific: Applies to PS3 only.

Referenced by isValid().

PxU32 PxBatchQueryDesc::spuPostFilterShaderSize

Size (in bytes) of the spu post filter shader codes spuPostFilterShader.

Default: 0

Platform specific: Applies to PS3 only.

Note

spuPreFilterShaderSize+spuPostFilterShaderSize+filterShaderDataSize should <= PX_QUERY_SPU_SHADER_LIMIT

See Also

spuPostFilterShader

Referenced by isValid().

void* PxBatchQueryDesc::spuPreFilterShader

The custom spu pre filter shader to use for collision filtering.

Note

This parameter is a fragment of SPU binary codes with the similar function of PxBatchQueryPreFilterShader. The requirement of the spu function is the same as PxBatchQueryPreFilterShader::filter. To compile the shader for spu, you can reference the implementation, makefile and awk scripts in SampleVehicle. If you don't want to define your own filter shader you can just leave this variable as NULL.

Platform specific: Applies to PS3 only.

Referenced by isValid().

PxU32 PxBatchQueryDesc::spuPreFilterShaderSize

Size (in bytes) of the spu pre filter shader codes spuPreFilterShader.

Default: 0

Platform specific: Applies to PS3 only.

Note

spuPreFilterShaderSize+spuPostFilterShaderSize+filterShaderDataSize should <= PX_QUERY_SPU_SHADER_LIMIT

See Also

spuPreFilterShader

Referenced by isValid().

---

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

• PxBatchQueryDesc.h