1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBatchQueryDesc Class Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
</head>
<body bgcolor="#FFFFFF">
<div id="header">
<hr class="first">
<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxBatchQueryDesc Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxBatchQueryDesc" -->Descriptor class for <a class="el" href="classPxBatchQuery.html" title="Batched queries object. This is used to perform several queries at the same time...">PxBatchQuery</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxBatchQueryDesc_8h-source.html">PxBatchQueryDesc.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for PxBatchQueryDesc:</div>
<div class="dynsection">
<p><center><img src="classPxBatchQueryDesc__coll__graph.png" border="0" usemap="#PxBatchQueryDesc__coll__map" alt="Collaboration graph"></center>
<map name="PxBatchQueryDesc__coll__map">
<area shape="rect" href="structPxBatchQueryMemory.html" title="Struct for PxBatchQuery memory pointers." alt="PxBatchQueryMemory" coords="97,720,236,741"><area shape="rect" href="structPxRaycastHit.html" title="Stores results of raycast queries." alt="PxRaycastHit" coords="319,629,404,650"><area shape="rect" href="structPxLocationHit.html" title="Scene query hit information for raycasts and sweeps returning hit position and normal..." alt="PxLocationHit" coords="211,538,296,560"><area shape="rect" href="structPxSweepHit.html" title="Stores results of sweep queries." alt="PxSweepHit" coords="212,629,295,650"><area shape="rect" href="structPxQueryHit.html" title="Scene query hit information." alt="PxQueryHit" coords="97,432,172,453"><area shape="rect" href="structPxOverlapHit.html" title="Stores results of overlap queries." alt="PxOverlapHit" coords="7,584,92,605"><area shape="rect" href="structPxActorShape.html" title="collection of set bits defined in PxHitFlag." alt="PxActorShape" coords="89,360,180,381"><area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="43,269,125,290"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="72,178,125,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="108,106,164,128"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="136,224,200,245"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,16,255,37"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="227,432,280,453"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxBatchQueryDesc-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#g7c50eeff3e586897d4441a18e43b7237">PxBatchQueryDesc</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxRaycastsPerExecute, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxSweepsPerExecute, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxOverlapsPerExecute)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a batch query with specified maximum number of queries per batch. <a href="group__physics.html#g7c50eeff3e586897d4441a18e43b7237"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__physics.html#g6c065d106bbbace6f2cc1d6f321af6bb">isValid</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#5f0ec12e1149c7960b9360c53615853c">filterShaderData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shared global filter data which will get passed into the filter shader. <a href="#5f0ec12e1149c7960b9360c53615853c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#35d9cb33ded71261de0c7695d75ecba9">filterShaderDataSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Size (in bytes) of the shared global filter data <a class="el" href="classPxBatchQueryDesc.html#5f0ec12e1149c7960b9360c53615853c" title="Shared global filter data which will get passed into the filter shader.">filterShaderData</a>. <a href="#35d9cb33ded71261de0c7695d75ecba9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__scenequery.html#ga1264802560d96e1740850b2e1a9856b">PxBatchQueryPreFilterShader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#f116e4058958b7c747dfd008317764ba">preFilterShader</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The custom preFilter shader to use for filtering. <a href="#f116e4058958b7c747dfd008317764ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__scenequery.html#g043a6549307b8fd63c96f48edafddad0">PxBatchQueryPostFilterShader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#1eae24bb23c561c4a656d7234d9d2e5e">postFilterShader</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The custom postFilter shader to use for filtering. <a href="#1eae24bb23c561c4a656d7234d9d2e5e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#9bca9313c79171e15a94615958672848">ownerClient</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">client that creates and owns this scene query. <a href="#9bca9313c79171e15a94615958672848"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxBatchQueryMemory.html">PxBatchQueryMemory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBatchQueryDesc.html#9dff8b59d67283672d41c6aa6ea7c882">queryMemory</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">User memory buffers for the query. <a href="#9dff8b59d67283672d41c6aa6ea7c882"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Descriptor class for <a class="el" href="classPxBatchQuery.html" title="Batched queries object. This is used to perform several queries at the same time...">PxBatchQuery</a>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>The batched query feature has been deprecated in PhysX version 3.4</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBatchQuery.html" title="Batched queries object. This is used to perform several queries at the same time...">PxBatchQuery</a> PxSceneQueryExecuteMode </dd></dl>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="5f0ec12e1149c7960b9360c53615853c"></a><!-- doxytag: member="PxBatchQueryDesc::filterShaderData" ref="5f0ec12e1149c7960b9360c53615853c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classPxBatchQueryDesc.html#5f0ec12e1149c7960b9360c53615853c">PxBatchQueryDesc::filterShaderData</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Shared global filter data which will get passed into the filter shader.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The provided data will get copied to internal buffers and this copy will be used for filtering calls.</dd></dl>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#g9db06e901a760fb02c06f27bf3e474b3" title="Filter shader to specify handling of collision pairs.">PxSimulationFilterShader</a> </dd></dl>
<p>Referenced by <a class="el" href="PxBatchQueryDesc_8h-source.html#l00299">isValid()</a>.</p>
</div>
</div><p>
<a class="anchor" name="35d9cb33ded71261de0c7695d75ecba9"></a><!-- doxytag: member="PxBatchQueryDesc::filterShaderDataSize" ref="35d9cb33ded71261de0c7695d75ecba9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxBatchQueryDesc.html#35d9cb33ded71261de0c7695d75ecba9">PxBatchQueryDesc::filterShaderDataSize</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Size (in bytes) of the shared global filter data <a class="el" href="classPxBatchQueryDesc.html#5f0ec12e1149c7960b9360c53615853c" title="Shared global filter data which will get passed into the filter shader.">filterShaderData</a>.
<p>
<b>Default:</b> 0<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__physics.html#g9db06e901a760fb02c06f27bf3e474b3" title="Filter shader to specify handling of collision pairs.">PxSimulationFilterShader</a> <a class="el" href="classPxBatchQueryDesc.html#5f0ec12e1149c7960b9360c53615853c" title="Shared global filter data which will get passed into the filter shader.">filterShaderData</a> </dd></dl>
<p>Referenced by <a class="el" href="PxBatchQueryDesc_8h-source.html#l00299">isValid()</a>.</p>
</div>
</div><p>
<a class="anchor" name="9bca9313c79171e15a94615958672848"></a><!-- doxytag: member="PxBatchQueryDesc::ownerClient" ref="9bca9313c79171e15a94615958672848" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_DEPRECATED <a class="el" href="PxClient_8h.html#cb0e5a85de6c250f2a54db46e3aa0a12">PxClientID</a> <a class="el" href="classPxBatchQueryDesc.html#9bca9313c79171e15a94615958672848">PxBatchQueryDesc::ownerClient</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
client that creates and owns this scene query.
<p>
This value will be used as an override when PX_DEFAULT_CLIENT value is passed to the query in <a class="el" href="structPxQueryFilterData.html#35b9a82ee48e11140e6a9698fc48213c" title="ID of the client doing the query (see PxScene.createClient()).">PxQueryFilterData.clientId</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#285849425521dd0344f55b4a7c0a834a" title="Reserves a new client ID.">PxScene::createClient()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1eae24bb23c561c4a656d7234d9d2e5e"></a><!-- doxytag: member="PxBatchQueryDesc::postFilterShader" ref="1eae24bb23c561c4a656d7234d9d2e5e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__scenequery.html#g043a6549307b8fd63c96f48edafddad0">PxBatchQueryPostFilterShader</a> <a class="el" href="classPxBatchQueryDesc.html#1eae24bb23c561c4a656d7234d9d2e5e">PxBatchQueryDesc::postFilterShader</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The custom postFilter shader to use for filtering.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#g043a6549307b8fd63c96f48edafddad0" title="Batched query post-filter shader.">PxBatchQueryPostFilterShader</a> PxDefaultPostFilterShader </dd></dl>
</div>
</div><p>
<a class="anchor" name="f116e4058958b7c747dfd008317764ba"></a><!-- doxytag: member="PxBatchQueryDesc::preFilterShader" ref="f116e4058958b7c747dfd008317764ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__scenequery.html#ga1264802560d96e1740850b2e1a9856b">PxBatchQueryPreFilterShader</a> <a class="el" href="classPxBatchQueryDesc.html#f116e4058958b7c747dfd008317764ba">PxBatchQueryDesc::preFilterShader</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The custom preFilter shader to use for filtering.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__scenequery.html#ga1264802560d96e1740850b2e1a9856b" title="Batched query pre-filter shader.">PxBatchQueryPreFilterShader</a> PxDefaultPreFilterShader </dd></dl>
</div>
</div><p>
<a class="anchor" name="9dff8b59d67283672d41c6aa6ea7c882"></a><!-- doxytag: member="PxBatchQueryDesc::queryMemory" ref="9dff8b59d67283672d41c6aa6ea7c882" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxBatchQueryMemory.html">PxBatchQueryMemory</a> <a class="el" href="classPxBatchQueryDesc.html#9dff8b59d67283672d41c6aa6ea7c882">PxBatchQueryDesc::queryMemory</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
User memory buffers for the query.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxBatchQueryMemory.html" title="Struct for PxBatchQuery memory pointers.">PxBatchQueryMemory</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxBatchQueryDesc_8h-source.html">PxBatchQueryDesc.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>
|