aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxGpuDispatcher_8h-source.html
blob: 189d83d516e2352aa2c51fca3784745fe8d8a416 (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
112
113
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxGpuDispatcher.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>PxGpuDispatcher.h</h1><a href="PxGpuDispatcher_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 <span class="preprocessor">#ifndef PXTASK_PXGPUDISPATCHER_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define PXTASK_PXGPUDISPATCHER_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="PxTaskDefine_8h.html">task/PxTaskDefine.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="PxTask_8h.html">task/PxTask.h</a>"</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="comment">/* forward decl to avoid including &lt;cuda.h&gt; */</span>
<a name="l00035"></a><a class="code" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">00035</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>CUstream_st* <a class="code" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">CUstream</a>;
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="keyword">namespace </span>physx
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">struct </span>PxGpuCopyDesc;
<a name="l00041"></a>00041 <span class="keyword">class </span>PxCudaContextManager;
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <a class="code" href="group__foundation.html#g1145ffab2cc9a77ca65b59ba4126342f">PX_PUSH_PACK_DEFAULT</a>
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="keyword">class </span>PxTaskManager;
<a name="l00046"></a>00046 
<a name="l00071"></a><a class="code" href="classphysx_1_1PxGpuDispatcher.html">00071</a> <span class="keyword">class </span><a class="code" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a>
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 <span class="keyword">public</span>:
<a name="l00080"></a>00080     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#091cb121a38ddf39fcab51f5118a15d2" title="Record the start of a simulation step.">startSimulation</a>() = 0;
<a name="l00081"></a>00081 
<a name="l00091"></a>00091     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#86f6db8b18cf8380967890d694e3df8e" title="Record the start of a GpuTask batch submission.">startGroup</a>() = 0;
<a name="l00092"></a>00092 
<a name="l00100"></a>00100     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#5ffc5d0c124afbcad0b6fcf1080af5ee" title="Submit a GpuTask for execution.">submitTask</a>(<a class="code" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies.">PxTask</a>&amp; task) = 0;
<a name="l00101"></a>00101 
<a name="l00110"></a>00110     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#2ec171af375195b782acce8fae4d2e93" title="Record the end of a GpuTask batch submission.">finishGroup</a>() = 0;
<a name="l00111"></a>00111 
<a name="l00135"></a>00135     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#27c2631f98a92733515f59823787fdc7" title="Add a CUDA completion prerequisite dependency to a task.">addCompletionPrereq</a>(<a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp; task) = 0;
<a name="l00136"></a>00136 
<a name="l00143"></a>00143     <span class="keyword">virtual</span> PxCudaContextManager* <a class="code" href="classphysx_1_1PxGpuDispatcher.html#d903de1449d82e6d9e51f610711f74d9" title="Retrieve the PxCudaContextManager associated with this PxGpuDispatcher.">getCudaContextManager</a>() = 0;
<a name="l00144"></a>00144 
<a name="l00151"></a>00151     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#b46896dea09105e1f5fc1d19a98f2b1b" title="Record the end of a simulation frame.">stopSimulation</a>() = 0;
<a name="l00152"></a>00152 
<a name="l00172"></a>00172     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#3157fe3020f29f2a4c3bdc5eb11b79c6" title="Returns true if a CUDA call has returned a non-recoverable error.">failureDetected</a>() <span class="keyword">const</span> = 0;
<a name="l00173"></a>00173 
<a name="l00180"></a>00180     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#0310275811d2b9df30ef6dfeda59333b" title="Force the PxGpuDispatcher into failure mode.">forceFailureMode</a>() = 0;
<a name="l00181"></a>00181 
<a name="l00201"></a>00201     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#7dbc8264abbffb8075f37e2d61205671" title="Launch a copy kernel with arbitrary number of copy commands.">launchCopyKernel</a>(PxGpuCopyDesc* desc, uint32_t count, <a class="code" href="PxGpuDispatcher_8h.html#b946c7f02e09efd788a204718015d88a">CUstream</a> stream) = 0;
<a name="l00202"></a>00202 
<a name="l00209"></a>00209     <span class="keyword">virtual</span> <a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp;         <a class="code" href="classphysx_1_1PxGpuDispatcher.html#3a12b661dab8671aaa9bd414c2b71440" title="Query pre launch task that runs before launching gpu kernels.">getPreLaunchTask</a>() = 0;
<a name="l00210"></a>00210 
<a name="l00217"></a>00217     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#7086ea741a0e605ba51f012743180353" title="Adds a gpu launch task that gets executed after the pre launch task.">addPreLaunchDependent</a>(<a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp; dependent) = 0;
<a name="l00218"></a>00218 
<a name="l00225"></a>00225     <span class="keyword">virtual</span> <a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp;         <a class="code" href="classphysx_1_1PxGpuDispatcher.html#e3c292cd7b8a431fa969116423e32254" title="Query post launch task that runs after the gpu is done.">getPostLaunchTask</a>() = 0;
<a name="l00226"></a>00226     
<a name="l00233"></a>00233     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                <a class="code" href="classphysx_1_1PxGpuDispatcher.html#c982dffd87d4252ea53906504d2cc349" title="Adds a task that gets executed after the post launch task.">addPostLaunchDependent</a>(<a class="code" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a>&amp; dependent) = 0;
<a name="l00234"></a>00234 
<a name="l00235"></a>00235 <span class="keyword">protected</span>:
<a name="l00240"></a><a class="code" href="classphysx_1_1PxGpuDispatcher.html#732e0687b5f29c5ec9cacf8674a0e805">00240</a>     <span class="keyword">virtual</span> <a class="code" href="classphysx_1_1PxGpuDispatcher.html#732e0687b5f29c5ec9cacf8674a0e805" title="protected destructor">~PxGpuDispatcher</a>() {}
<a name="l00241"></a>00241 };
<a name="l00242"></a>00242 
<a name="l00243"></a>00243 <a class="code" href="group__foundation.html#g9aad3b08e5e15565ff39638b753f4a92">PX_POP_PACK</a>
<a name="l00244"></a>00244 
<a name="l00245"></a>00245 } <span class="comment">// end physx namespace</span>
<a name="l00246"></a>00246 
<a name="l00247"></a>00247 
<a name="l00248"></a>00248 <span class="preprocessor">#endif // PXTASK_PXGPUDISPATCHER_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>