aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxGpuTask_8h-source.html
blob: 7f017373098eb57326ee7a8c553366a8a9d09a75 (plain) (blame)
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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxGpuTask.h Source File</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> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxGpuTask.h</h1><a href="PxGpuTask_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00003"></a>00003 <span class="comment">// modification, are permitted provided that the following conditions</span>
<a name="l00004"></a>00004 <span class="comment">// are met:</span>
<a name="l00005"></a>00005 <span class="comment">//  * Redistributions of source code must retain the above copyright</span>
<a name="l00006"></a>00006 <span class="comment">//    notice, this list of conditions and the following disclaimer.</span>
<a name="l00007"></a>00007 <span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00008"></a>00008 <span class="comment">//    notice, this list of conditions and the following disclaimer in the</span>
<a name="l00009"></a>00009 <span class="comment">//    documentation and/or other materials provided with the distribution.</span>
<a name="l00010"></a>00010 <span class="comment">//  * Neither the name of NVIDIA CORPORATION nor the names of its</span>
<a name="l00011"></a>00011 <span class="comment">//    contributors may be used to endorse or promote products derived</span>
<a name="l00012"></a>00012 <span class="comment">//    from this software without specific prior written permission.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY</span>
<a name="l00015"></a>00015 <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00016"></a>00016 <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
<a name="l00017"></a>00017 <span class="comment">// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00018"></a>00018 <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00019"></a>00019 <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00020"></a>00020 <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00021"></a>00021 <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
<a name="l00022"></a>00022 <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00023"></a>00023 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00024"></a>00024 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef PXTASK_PXGPUTASK_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define PXTASK_PXGPUTASK_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="PxTaskDefine_8h.html">task/PxTaskDefine.h</a>"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="PxTask_8h.html">task/PxTask.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="PxGpuDispatcher_8h.html">task/PxGpuDispatcher.h</a>"</span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">namespace </span>physx
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <a class="code" href="group__foundation.html#g1145ffab2cc9a77ca65b59ba4126342f">PX_PUSH_PACK_DEFAULT</a>
<a name="l00040"></a>00040 
<a name="l00051"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html">00051</a> <span class="keyword">struct </span><a class="code" href="structphysx_1_1PxGpuTaskHint.html" title="Define the &amp;#39;flavor&amp;#39; of a PxGpuTask.">PxGpuTaskHint</a>
<a name="l00052"></a>00052 {
<a name="l00054"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80">00054</a>     <span class="keyword">enum</span> <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80" title="Enums for the type of GPU task.">Enum</a>
<a name="l00055"></a>00055     {
<a name="l00056"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80d78c9d3251fa699d8efaa7a4116c3679">00056</a>         <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80d78c9d3251fa699d8efaa7a4116c3679">HostToDevice</a>,
<a name="l00057"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc8037e966d05930ba223ff4a7bff05b0be2">00057</a>         <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc8037e966d05930ba223ff4a7bff05b0be2">Kernel</a>,
<a name="l00058"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80216f52509c0a9d07ef556dfe17dff8c6">00058</a>         <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80216f52509c0a9d07ef556dfe17dff8c6">DeviceToHost</a>,
<a name="l00059"></a>00059 
<a name="l00060"></a><a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80bc8bb0ca370c3819f7da087a48fdf84a">00060</a>         <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80bc8bb0ca370c3819f7da087a48fdf84a">NUM_GPU_TASK_HINTS</a>
<a name="l00061"></a>00061     };
<a name="l00062"></a>00062 };
<a name="l00063"></a>00063 
<a name="l00067"></a><a class="code" href="classphysx_1_1PxGpuTask.html">00067</a> <span class="keyword">class </span><a class="code" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work.">PxGpuTask</a> : <span class="keyword">public</span> <a class="code" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies.">PxTask</a>
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keyword">public</span>:
<a name="l00070"></a><a class="code" href="classphysx_1_1PxGpuTask.html#7d727e580b4bca6074447f178aded143">00070</a>     <a class="code" href="classphysx_1_1PxGpuTask.html#7d727e580b4bca6074447f178aded143">PxGpuTask</a>() : <a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a>(NULL) {}
<a name="l00071"></a>00071 
<a name="l00083"></a>00083     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>    <a class="code" href="classphysx_1_1PxGpuTask.html#b49d589153d349e8176c1cd82404edee" title="iterative &amp;quot;run&amp;quot; function for a PxGpuTask">launchInstance</a>(<a class="code" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">CUstream</a> stream, <span class="keywordtype">int</span> kernelIndex) = 0;
<a name="l00084"></a>00084 
<a name="l00088"></a>00088     <span class="keyword">virtual</span> <a class="code" href="structphysx_1_1PxGpuTaskHint.html#d04073eff7b52fedb0f551f7583bbc80" title="Enums for the type of GPU task.">PxGpuTaskHint::Enum</a> <a class="code" href="classphysx_1_1PxGpuTask.html#9ab3b350e19305096a955bf29bffc923" title="Returns a hint indicating the function of this task.">getTaskHint</a>() <span class="keyword">const</span> = 0;
<a name="l00089"></a>00089 
<a name="l00094"></a><a class="code" href="classphysx_1_1PxGpuTask.html#70580dd1b3cfde44c4cbb66064cdab4c">00094</a>     <span class="keywordtype">void</span> <a class="code" href="classphysx_1_1PxGpuTask.html#70580dd1b3cfde44c4cbb66064cdab4c" title="Specify a task that will have its reference count decremented when this task is released...">setCompletionTask</a>(<a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp; task)
<a name="l00095"></a>00095     {
<a name="l00096"></a>00096         <a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a> = &amp;task;
<a name="l00097"></a>00097     }
<a name="l00098"></a>00098 
<a name="l00099"></a><a class="code" href="classphysx_1_1PxGpuTask.html#31d2f0fa38080d3bc7e0324f52c902ef">00099</a>     <span class="keywordtype">void</span> <a class="code" href="classphysx_1_1PxGpuTask.html#31d2f0fa38080d3bc7e0324f52c902ef" title="Release method implementation.">release</a>()
<a name="l00100"></a>00100     {
<a name="l00101"></a>00101         <span class="keywordflow">if</span> (<a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a>)
<a name="l00102"></a>00102         {
<a name="l00103"></a>00103             <a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a>-&gt;<a class="code" href="classphysx_1_1PxBaseTask.html#78f9b745c6fb4114350cb1a26f3461d3" title="Implemented by derived implementation classes.">removeReference</a>();
<a name="l00104"></a>00104             <a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a> = NULL;
<a name="l00105"></a>00105         }
<a name="l00106"></a>00106         <a class="code" href="classphysx_1_1PxGpuTask.html#31d2f0fa38080d3bc7e0324f52c902ef" title="Release method implementation.">PxTask::release</a>();
<a name="l00107"></a>00107     }
<a name="l00108"></a>00108 
<a name="l00109"></a>00109 <span class="keyword">protected</span>:
<a name="l00111"></a><a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa">00111</a>     <a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>* <a class="code" href="classphysx_1_1PxGpuTask.html#18cae0d516f37c4a00d1d53fd77667aa" title="A pointer to the completion task.">mComp</a>;
<a name="l00112"></a>00112 };
<a name="l00113"></a>00113 
<a name="l00114"></a>00114 <a class="code" href="group__foundation.html#g9aad3b08e5e15565ff39638b753f4a92">PX_POP_PACK</a>
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 } <span class="comment">// end physx namespace</span>
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="preprocessor">#endif // PXTASK_PXGPUTASK_H</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 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>