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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxGpuTask 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="navpath"><a class="el" href="namespacephysx.html">physx</a>::<a class="el" href="classphysx_1_1PxGpuTask.html">PxGpuTask</a>
</div>
<div class="contents">
<h1>physx::PxGpuTask Class Reference</h1><!-- doxytag: class="physx::PxGpuTask" --><!-- doxytag: inherits="physx::PxTask" --><a class="el" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies.">PxTask</a> implementation for launching CUDA work.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxGpuTask_8h-source.html">PxGpuTask.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for physx::PxGpuTask:</div>
<div class="dynsection">
<p><center><img src="classphysx_1_1PxGpuTask__inherit__graph.png" border="0" usemap="#physx_1_1PxGpuTask__inherit__map" alt="Inheritance graph"></center>
<map name="physx_1_1PxGpuTask__inherit__map">
<area shape="rect" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies." alt="physx::PxTask" coords="23,85,116,106"><area shape="rect" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types." alt="physx::PxBaseTask" coords="7,16,132,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for physx::PxGpuTask:</div>
<div class="dynsection">
<p><center><img src="classphysx_1_1PxGpuTask__coll__graph.png" border="0" usemap="#physx_1_1PxGpuTask__coll__map" alt="Collaboration graph"></center>
<map name="physx_1_1PxGpuTask__coll__map">
<area shape="rect" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies." alt="physx::PxTask" coords="135,178,228,200"><area shape="rect" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types." alt="physx::PxBaseTask" coords="16,106,141,128"><area shape="rect" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface." alt="physx::PxTaskManager" coords="7,16,151,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classphysx_1_1PxGpuTask-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#7d727e580b4bca6074447f178aded143">PxGpuTask</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#b49d589153d349e8176c1cd82404edee">launchInstance</a> (<a class="el" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">CUstream</a> stream, int kernelIndex)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">iterative "run" function for a <a class="el" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work.">PxGpuTask</a> <a href="#b49d589153d349e8176c1cd82404edee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80">PxGpuTaskHint::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#9ab3b350e19305096a955bf29bffc923">getTaskHint</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a hint indicating the function of this task. <a href="#9ab3b350e19305096a955bf29bffc923"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#70580dd1b3cfde44c4cbb66064cdab4c">setCompletionTask</a> (<a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a> &task)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify a task that will have its reference count decremented when this task is released. <a href="#70580dd1b3cfde44c4cbb66064cdab4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#31d2f0fa38080d3bc7e0324f52c902ef">release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release method implementation. <a href="#31d2f0fa38080d3bc7e0324f52c902ef"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa">mComp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the completion task. <a href="#18cae0d516f37c4a00d1d53fd77667aa"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies.">PxTask</a> implementation for launching CUDA work. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7d727e580b4bca6074447f178aded143"></a><!-- doxytag: member="physx::PxGpuTask::PxGpuTask" ref="7d727e580b4bca6074447f178aded143" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">physx::PxGpuTask::PxGpuTask </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9ab3b350e19305096a955bf29bffc923"></a><!-- doxytag: member="physx::PxGpuTask::getTaskHint" ref="9ab3b350e19305096a955bf29bffc923" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80">PxGpuTaskHint::Enum</a> physx::PxGpuTask::getTaskHint </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a hint indicating the function of this task.
<p>
</div>
</div><p>
<a class="anchor" name="b49d589153d349e8176c1cd82404edee"></a><!-- doxytag: member="physx::PxGpuTask::launchInstance" ref="b49d589153d349e8176c1cd82404edee" args="(CUstream stream, int kernelIndex)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool physx::PxGpuTask::launchInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">CUstream</a> </td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>kernelIndex</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
iterative "run" function for a <a class="el" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work.">PxGpuTask</a>
<p>
The GpuDispatcher acquires the CUDA context for the duration of this function call, and it is highly recommended that the <a class="el" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work.">PxGpuTask</a> use the provided CUstream for all kernels.<p>
kernelIndex will be 0 for the initial call and incremented before each subsequent call. Once <a class="el" href="classphysx_1_1PxGpuTask.html#b49d589153d349e8176c1cd82404edee" title="iterative "run" function for a PxGpuTask">launchInstance()</a> returns false, its <a class="el" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work.">PxGpuTask</a> is considered completed and is released.
</div>
</div><p>
<a class="anchor" name="31d2f0fa38080d3bc7e0324f52c902ef"></a><!-- doxytag: member="physx::PxGpuTask::release" ref="31d2f0fa38080d3bc7e0324f52c902ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void physx::PxGpuTask::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release method implementation.
<p>
<p>Reimplemented from <a class="el" href="classphysx_1_1PxTask.html#cedcca7b8305c3ad519e537ab307c39a">physx::PxTask</a>.</p>
<p>References <a class="el" href="PxGpuTask_8h-source.html#l00111">mComp</a>, and <a class="el" href="classphysx_1_1PxBaseTask.html#78f9b745c6fb4114350cb1a26f3461d3">physx::PxBaseTask::removeReference()</a>.</p>
</div>
</div><p>
<a class="anchor" name="70580dd1b3cfde44c4cbb66064cdab4c"></a><!-- doxytag: member="physx::PxGpuTask::setCompletionTask" ref="70580dd1b3cfde44c4cbb66064cdab4c" args="(PxBaseTask &task)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void physx::PxGpuTask::setCompletionTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a> & </td>
<td class="paramname"> <em>task</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify a task that will have its reference count decremented when this task is released.
<p>
<p>References <a class="el" href="PxGpuTask_8h-source.html#l00111">mComp</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="18cae0d516f37c4a00d1d53fd77667aa"></a><!-- doxytag: member="physx::PxGpuTask::mComp" ref="18cae0d516f37c4a00d1d53fd77667aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a>* <a class="el" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa">physx::PxGpuTask::mComp</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A pointer to the completion task.
<p>
<p>Referenced by <a class="el" href="PxGpuTask_8h-source.html#l00099">release()</a>, and <a class="el" href="PxGpuTask_8h-source.html#l00094">setCompletionTask()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxGpuTask_8h-source.html">PxGpuTask.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>
|