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

PxBatchQueryDesc Class Reference
+ +[Physics] +

Descriptor class for PxBatchQuery. +More... +

+#include <PxBatchQueryDesc.h> +

+

+Collaboration diagram for PxBatchQueryDesc:
+
+

Collaboration graph
+ +PxBatchQueryMemoryPxRaycastHitPxLocationHitPxSweepHitPxQueryHitPxOverlapHitPxActorShapePxRigidActorPxActorPxBasePxShapePxFlags\< PxBaseFlag::Enum, PxU16 \>PxVec3 +
[legend]
+ +

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

Public Member Functions

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

Public Attributes

void * filterShaderData
 Shared global filter data which will get passed into the filter shader.
PxU32 filterShaderDataSize
 Size (in bytes) of the shared global filter data filterShaderData.
PxBatchQueryPreFilterShader preFilterShader
 The custom preFilter shader to use for filtering.
PxBatchQueryPostFilterShader postFilterShader
 The custom postFilter shader to use for filtering.
PX_DEPRECATED PxClientID ownerClient
 client that creates and owns this scene query.
PxBatchQueryMemory queryMemory
 User memory buffers for the query.
+

Detailed Description

+Descriptor class for PxBatchQuery. +

+

Deprecated:
The batched query feature has been deprecated in PhysX version 3.4
+
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().

+ +
+

+ +

+
+ + + + +
PX_DEPRECATED 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
+ +
+

+ +

+
+ + + + +
PxBatchQueryPreFilterShader PxBatchQueryDesc::preFilterShader
+
+
+ +

+The custom preFilter shader to use for filtering. +

+

See also:
PxBatchQueryPreFilterShader PxDefaultPreFilterShader
+ +
+

+ +

+
+ + + + +
PxBatchQueryMemory PxBatchQueryDesc::queryMemory
+
+
+ +

+User memory buffers for the query. +

+

See also:
PxBatchQueryMemory
+ +
+

+

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