aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html')
-rw-r--r--PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html444
1 files changed, 444 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html
new file mode 100644
index 00000000..db07e44c
--- /dev/null
+++ b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html
@@ -0,0 +1,444 @@
+<html>
+ <head>
+ <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxBaseTask 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="navpath"><a class="el" href="namespacephysx.html">physx</a>::<a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a>
+ </div>
+<div class="contents">
+<h1>physx::PxBaseTask Class Reference</h1><!-- doxytag: class="physx::PxBaseTask" -->Base class of all task types.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="PxTask_8h-source.html">PxTask.h</a>&gt;</code>
+<p>
+<div class="dynheader">
+Inheritance diagram for physx::PxBaseTask:</div>
+<div class="dynsection">
+<p><center><img src="classphysx_1_1PxBaseTask__inherit__graph.png" border="0" usemap="#physx_1_1PxBaseTask__inherit__map" alt="Inheritance graph"></center>
+<map name="physx_1_1PxBaseTask__inherit__map">
+<area shape="rect" href="classphysx_1_1PxLightCpuTask.html" title="A PxBaseTask implementation with immediate execution and simple dependencies." alt="physx::PxLightCpuTask" coords="7,85,151,106"><area shape="rect" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies." alt="physx::PxTask" coords="175,85,268,106"><area shape="rect" href="classphysx_1_1PxGpuTask.html" title="PxTask implementation for launching CUDA work." alt="physx::PxGpuTask" coords="161,154,281,176"></map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
+<div class="dynheader">
+Collaboration diagram for physx::PxBaseTask:</div>
+<div class="dynsection">
+<p><center><img src="classphysx_1_1PxBaseTask__coll__graph.png" border="0" usemap="#physx_1_1PxBaseTask__coll__map" alt="Collaboration graph"></center>
+<map name="physx_1_1PxBaseTask__coll__map">
+<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_1PxBaseTask-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#387b986ef3916322502452724d9ba582">PxBaseTask</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#c3100494c97a23a88fcad8e28e222822">~PxBaseTask</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#517a16d9dc630c9274a7564deb3a7e4a">run</a> ()=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The user-implemented run method where the task's work should be performed. <a href="#517a16d9dc630c9274a7564deb3a7e4a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a54eb4a1b50979436a797a62e383efee">getName</a> () const =0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a user-provided task name for profiling purposes. <a href="#a54eb4a1b50979436a797a62e383efee"></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="classphysx_1_1PxBaseTask.html#07c9f6e71f0723bcf914fce51036d36e">addReference</a> ()=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#07c9f6e71f0723bcf914fce51036d36e"></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="classphysx_1_1PxBaseTask.html#78f9b745c6fb4114350cb1a26f3461d3">removeReference</a> ()=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#78f9b745c6fb4114350cb1a26f3461d3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#5a1570309c62a12c3ecfe7e695b9f21f">getReference</a> () const =0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#5a1570309c62a12c3ecfe7e695b9f21f"></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="classphysx_1_1PxBaseTask.html#3be62f992c1ff7218e2cf0fc0ba5b244">release</a> ()=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#3be62f992c1ff7218e2cf0fc0ba5b244"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#c5afbb44814fd220d9fa1f5ae407f21d">runProfiled</a> (uint32_t threadId=0)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Execute user run method with wrapping profiling events. <a href="#c5afbb44814fd220d9fa1f5ae407f21d"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#0621abfb63132826ccd37421b9d8011f">setProfileStat</a> (uint16_t stat)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specify stop event statistic. <a href="#0621abfb63132826ccd37421b9d8011f"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#f33b34783821f4b8cc455df2e7f45bbe">getTaskManager</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> to which this task was submitted. <a href="#f33b34783821f4b8cc455df2e7f45bbe"></a><br></td></tr>
+<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#9200c8e7b7680790e5e75da22c92e3cd">mEventID</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Registered profile event ID. <a href="#9200c8e7b7680790e5e75da22c92e3cd"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#859800d5acb01168c7fae071d8e86e26">mProfileStat</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Profiling statistic. <a href="#859800d5acb01168c7fae071d8e86e26"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#f23fffec1e92c794d3ad73e9fc4fa974">mTm</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Owning <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> instance. <a href="#f23fffec1e92c794d3ad73e9fc4fa974"></a><br></td></tr>
+<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#c4a43ca8ae513a20c1d61bc9aecfce89">PxTaskMgr</a></td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Base class of all task types.
+<p>
+<a class="el" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types.">PxBaseTask</a> defines a runnable reference counted task with built-in profiling. <hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="387b986ef3916322502452724d9ba582"></a><!-- doxytag: member="physx::PxBaseTask::PxBaseTask" ref="387b986ef3916322502452724d9ba582" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">physx::PxBaseTask::PxBaseTask </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="c3100494c97a23a88fcad8e28e222822"></a><!-- doxytag: member="physx::PxBaseTask::~PxBaseTask" ref="c3100494c97a23a88fcad8e28e222822" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual physx::PxBaseTask::~PxBaseTask </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline, virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="07c9f6e71f0723bcf914fce51036d36e"></a><!-- doxytag: member="physx::PxBaseTask::addReference" ref="07c9f6e71f0723bcf914fce51036d36e" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void physx::PxBaseTask::addReference </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [pure virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Implemented by derived implementation classes.
+<p>
+
+<p>Implemented in <a class="el" href="classphysx_1_1PxTask.html#d3828abb4bd2237af28ecd08b972b1af">physx::PxTask</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#572d87fd23a65723d8e817f65e4681e6">physx::PxLightCpuTask</a>.</p>
+
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00272">physx::PxLightCpuTask::setContinuation()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="a54eb4a1b50979436a797a62e383efee"></a><!-- doxytag: member="physx::PxBaseTask::getName" ref="a54eb4a1b50979436a797a62e383efee" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual const char* physx::PxBaseTask::getName </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>
+Return a user-provided task name for profiling purposes.
+<p>
+It does not have to be unique, but unique names are helpful.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of this task </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="5a1570309c62a12c3ecfe7e695b9f21f"></a><!-- doxytag: member="physx::PxBaseTask::getReference" ref="5a1570309c62a12c3ecfe7e695b9f21f" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual int32_t physx::PxBaseTask::getReference </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>
+Implemented by derived implementation classes.
+<p>
+
+<p>Implemented in <a class="el" href="classphysx_1_1PxTask.html#7d7d155ba008883d3bed7db443421908">physx::PxTask</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#e45cef54851865477ee4f187e1fb5126">physx::PxLightCpuTask</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="f33b34783821f4b8cc455df2e7f45bbe"></a><!-- doxytag: member="physx::PxBaseTask::getTaskManager" ref="f33b34783821f4b8cc455df2e7f45bbe" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">PX_INLINE <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a>* physx::PxBaseTask::getTaskManager </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td> const<code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Return <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> to which this task was submitted.
+<p>
+Note, can return NULL if task was not submitted, or has been completed.
+<p>References <a class="el" href="PxTask_8h-source.html#l00125">mTm</a>.</p>
+
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00291">physx::PxLightCpuTask::setContinuation()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="3be62f992c1ff7218e2cf0fc0ba5b244"></a><!-- doxytag: member="physx::PxBaseTask::release" ref="3be62f992c1ff7218e2cf0fc0ba5b244" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void physx::PxBaseTask::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>
+Implemented by derived implementation classes.
+<p>
+A task may assume in its <a class="el" href="classphysx_1_1PxBaseTask.html#3be62f992c1ff7218e2cf0fc0ba5b244" title="Implemented by derived implementation classes.">release()</a> method that the task system no longer holds references to it - so it may safely run its destructor, recycle itself, etc. provided no additional user references to the task exist
+<p>Implemented in <a class="el" href="classphysx_1_1PxGpuTask.html#31d2f0fa38080d3bc7e0324f52c902ef">physx::PxGpuTask</a>, <a class="el" href="classphysx_1_1PxTask.html#cedcca7b8305c3ad519e537ab307c39a">physx::PxTask</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#ea23c57ffecb54f397089de1f3b0ad20">physx::PxLightCpuTask</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="78f9b745c6fb4114350cb1a26f3461d3"></a><!-- doxytag: member="physx::PxBaseTask::removeReference" ref="78f9b745c6fb4114350cb1a26f3461d3" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void physx::PxBaseTask::removeReference </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [pure virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Implemented by derived implementation classes.
+<p>
+
+<p>Implemented in <a class="el" href="classphysx_1_1PxTask.html#097c70f1419ad4991ef876ddd9a74d48">physx::PxTask</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#4f847956e5ba51a36bbb3ced5bb15a6c">physx::PxLightCpuTask</a>.</p>
+
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00342">physx::PxLightCpuTask::release()</a>, and <a class="el" href="PxGpuTask_8h-source.html#l00099">physx::PxGpuTask::release()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="517a16d9dc630c9274a7564deb3a7e4a"></a><!-- doxytag: member="physx::PxBaseTask::run" ref="517a16d9dc630c9274a7564deb3a7e4a" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void physx::PxBaseTask::run </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [pure virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+The user-implemented run method where the task's work should be performed.
+<p>
+<a class="el" href="classphysx_1_1PxBaseTask.html#517a16d9dc630c9274a7564deb3a7e4a" title="The user-implemented run method where the task&#39;s work should be performed.">run()</a> methods must be thread safe, stack friendly (no alloca, etc), and must never block.
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00091">runProfiled()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="c5afbb44814fd220d9fa1f5ae407f21d"></a><!-- doxytag: member="physx::PxBaseTask::runProfiled" ref="c5afbb44814fd220d9fa1f5ae407f21d" args="(uint32_t threadId=0)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">PX_INLINE void physx::PxBaseTask::runProfiled </td>
+ <td>(</td>
+ <td class="paramtype">uint32_t&nbsp;</td>
+ <td class="paramname"> <em>threadId</em> = <code>0</code> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Execute user run method with wrapping profiling events.
+<p>
+Optional entry point for use by CpuDispatchers.<p>
+<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>threadId</em>&nbsp;</td><td>The threadId of the thread that executed the task. </td></tr>
+ </table>
+</dl>
+
+<p>References <a class="el" href="PxTask_8h-source.html#l00125">mTm</a>, and <a class="el" href="classphysx_1_1PxBaseTask.html#517a16d9dc630c9274a7564deb3a7e4a">run()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0621abfb63132826ccd37421b9d8011f"></a><!-- doxytag: member="physx::PxBaseTask::setProfileStat" ref="0621abfb63132826ccd37421b9d8011f" args="(uint16_t stat)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">PX_INLINE void physx::PxBaseTask::setProfileStat </td>
+ <td>(</td>
+ <td class="paramtype">uint16_t&nbsp;</td>
+ <td class="paramname"> <em>stat</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td><code> [inline]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Specify stop event statistic.
+<p>
+If called before or while the task is executing, the given value will appear in the task's event bar in the profile viewer<p>
+<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>stat</em>&nbsp;</td><td>The stat to signal when the task is finished </td></tr>
+ </table>
+</dl>
+
+<p>References <a class="el" href="PxTask_8h-source.html#l00124">mProfileStat</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Friends And Related Function Documentation</h2>
+<a class="anchor" name="c4a43ca8ae513a20c1d61bc9aecfce89"></a><!-- doxytag: member="physx::PxBaseTask::PxTaskMgr" ref="c4a43ca8ae513a20c1d61bc9aecfce89" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">friend class PxTaskMgr<code> [friend]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Reimplemented in <a class="el" href="classphysx_1_1PxTask.html#c4a43ca8ae513a20c1d61bc9aecfce89">physx::PxTask</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#c4a43ca8ae513a20c1d61bc9aecfce89">physx::PxLightCpuTask</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Member Data Documentation</h2>
+<a class="anchor" name="9200c8e7b7680790e5e75da22c92e3cd"></a><!-- doxytag: member="physx::PxBaseTask::mEventID" ref="9200c8e7b7680790e5e75da22c92e3cd" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint16_t <a class="el" href="classphysx_1_1PxBaseTask.html#9200c8e7b7680790e5e75da22c92e3cd">physx::PxBaseTask::mEventID</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Registered profile event ID.
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="859800d5acb01168c7fae071d8e86e26"></a><!-- doxytag: member="physx::PxBaseTask::mProfileStat" ref="859800d5acb01168c7fae071d8e86e26" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint16_t <a class="el" href="classphysx_1_1PxBaseTask.html#859800d5acb01168c7fae071d8e86e26">physx::PxBaseTask::mProfileStat</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Profiling statistic.
+<p>
+
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00106">setProfileStat()</a>, and <a class="el" href="PxTask_8h-source.html#l00211">physx::PxTask::submitted()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="f23fffec1e92c794d3ad73e9fc4fa974"></a><!-- doxytag: member="physx::PxBaseTask::mTm" ref="f23fffec1e92c794d3ad73e9fc4fa974" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a>* <a class="el" href="classphysx_1_1PxBaseTask.html#f23fffec1e92c794d3ad73e9fc4fa974">physx::PxBaseTask::mTm</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Owning <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> instance.
+<p>
+
+<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00332">physx::PxLightCpuTask::addReference()</a>, <a class="el" href="PxTask_8h-source.html#l00174">physx::PxTask::addReference()</a>, <a class="el" href="PxTask_8h-source.html#l00156">physx::PxTask::finishBefore()</a>, <a class="el" href="PxTask_8h-source.html#l00193">physx::PxTask::getReference()</a>, <a class="el" href="PxTask_8h-source.html#l00117">getTaskManager()</a>, <a class="el" href="PxTask_8h-source.html#l00144">physx::PxTask::release()</a>, <a class="el" href="PxTask_8h-source.html#l00317">physx::PxLightCpuTask::removeReference()</a>, <a class="el" href="PxTask_8h-source.html#l00184">physx::PxTask::removeReference()</a>, <a class="el" href="PxTask_8h-source.html#l00091">runProfiled()</a>, <a class="el" href="PxTask_8h-source.html#l00272">physx::PxLightCpuTask::setContinuation()</a>, <a class="el" href="PxTask_8h-source.html#l00164">physx::PxTask::startAfter()</a>, and <a class="el" href="PxTask_8h-source.html#l00258">physx::PxLightCpuTask::~PxLightCpuTask()</a>.</p>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="PxTask_8h-source.html">PxTask.h</a></ul>
+</div>
+
+<hr style="width: 100%; height: 2px;"><br>
+Copyright &copy; 2008-2016 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>