PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultCpuDispatcher.html


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

<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultCpuDispatcher 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> &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 -->
<div class="contents">
<h1>PxDefaultCpuDispatcher Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxDefaultCpuDispatcher" -->A default implementation for a CPU task dispatcher.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxDefaultCpuDispatcher_8h-source.html">PxDefaultCpuDispatcher.h</a>&gt;</code>
<p>

<p>
<a href="classPxDefaultCpuDispatcher-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultCpuDispatcher.html#504bfbc6f76ee2bda3d6b7e505fbec72">release</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes the dispatcher.  <a href="#504bfbc6f76ee2bda3d6b7e505fbec72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultCpuDispatcher.html#ccb465b8fcfd7f5e257e2e6f042703f1">setRunProfiled</a> (bool runProfiled)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables profiling at task level.  <a href="#ccb465b8fcfd7f5e257e2e6f042703f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultCpuDispatcher.html#40f8719e94a4b87017c1865b85ac1930">getRunProfiled</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if profiling is enabled at task level.  <a href="#40f8719e94a4b87017c1865b85ac1930"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A default implementation for a CPU task dispatcher. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g68e9b3c3ee8961234464d8eb0b64d5e3" title="Create default dispatcher, extensions SDK needs to be initialized first.">PxDefaultCpuDispatcherCreate()</a> PxCpuDispatcher </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="40f8719e94a4b87017c1865b85ac1930"></a><!-- doxytag: member="PxDefaultCpuDispatcher::getRunProfiled" ref="40f8719e94a4b87017c1865b85ac1930" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxDefaultCpuDispatcher::getRunProfiled           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Checks if profiling is enabled at task level. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if tasks should be profiled. </dd></dl>

</div>
</div><p>
<a class="anchor" name="504bfbc6f76ee2bda3d6b7e505fbec72"></a><!-- doxytag: member="PxDefaultCpuDispatcher::release" ref="504bfbc6f76ee2bda3d6b7e505fbec72" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxDefaultCpuDispatcher::release           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Deletes the dispatcher. 
<p>
Do not keep a reference to the deleted instance.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__extensions.html#g68e9b3c3ee8961234464d8eb0b64d5e3" title="Create default dispatcher, extensions SDK needs to be initialized first.">PxDefaultCpuDispatcherCreate()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="ccb465b8fcfd7f5e257e2e6f042703f1"></a><!-- doxytag: member="PxDefaultCpuDispatcher::setRunProfiled" ref="ccb465b8fcfd7f5e257e2e6f042703f1" args="(bool runProfiled)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxDefaultCpuDispatcher::setRunProfiled           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>runProfiled</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Enables profiling at task level. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>By default enabled only in profiling builds.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>runProfiled</em>&nbsp;</td><td>True if tasks should be profiled. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxDefaultCpuDispatcher_8h-source.html">PxDefaultCpuDispatcher.h</a></ul>
</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>