dev0/PhysX4.1
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a3a8e7970943b1cbac0ad7fc05b7768c184db5e9
PhysX4.1/physx/documentation/PhysXAPI/files/classphysx_1_1PxBaseTask.html
dev0 a3a8e79709 Init
2025-11-28 23:13:44 +05:30

574 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>physx::PxBaseTask Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classphysx_1_1PxBaseTask.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classphysx_1_1PxBaseTask-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">physx::PxBaseTask Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class of all task types.
<a href="classphysx_1_1PxBaseTask.html#details">More...</a></p>
<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="dyncontent">
<div class="center"><img src="classphysx_1_1PxBaseTask__inherit__graph.png" border="0" usemap="#physx_1_1PxBaseTask_inherit__map" alt="Inheritance graph"/></div>
<map name="physx_1_1PxBaseTask_inherit__map" id="physx_1_1PxBaseTask_inherit__map">
<area shape="rect" id="node2" href="classphysx_1_1PxLightCpuTask.html" title="A PxBaseTask implementation with immediate execution and simple dependencies. " alt="" coords="5,80,165,107"/>
<area shape="rect" id="node3" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies. " alt="" coords="189,80,299,107"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for physx::PxBaseTask:</div>
<div class="dyncontent">
<div class="center"><img src="classphysx_1_1PxBaseTask__coll__graph.png" border="0" usemap="#physx_1_1PxBaseTask_coll__map" alt="Collaboration graph"/></div>
<map name="physx_1_1PxBaseTask_coll__map" id="physx_1_1PxBaseTask_coll__map">
<area shape="rect" id="node2" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. " alt="" coords="5,5,164,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a387b986ef3916322502452724d9ba582"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a387b986ef3916322502452724d9ba582">PxBaseTask</a> ()</td></tr>
<tr class="separator:a387b986ef3916322502452724d9ba582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3100494c97a23a88fcad8e28e222822"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#ac3100494c97a23a88fcad8e28e222822">~PxBaseTask</a> ()</td></tr>
<tr class="separator:ac3100494c97a23a88fcad8e28e222822"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a517a16d9dc630c9274a7564deb3a7e4a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a517a16d9dc630c9274a7564deb3a7e4a">run</a> ()=0</td></tr>
<tr class="memdesc:a517a16d9dc630c9274a7564deb3a7e4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user-implemented run method where the task's work should be performed. <a href="#a517a16d9dc630c9274a7564deb3a7e4a">More...</a><br /></td></tr>
<tr class="separator:a517a16d9dc630c9274a7564deb3a7e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa54eb4a1b50979436a797a62e383efee"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#aa54eb4a1b50979436a797a62e383efee">getName</a> () const =0</td></tr>
<tr class="memdesc:aa54eb4a1b50979436a797a62e383efee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a user-provided task name for profiling purposes. <a href="#aa54eb4a1b50979436a797a62e383efee">More...</a><br /></td></tr>
<tr class="separator:aa54eb4a1b50979436a797a62e383efee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c9f6e71f0723bcf914fce51036d36e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a07c9f6e71f0723bcf914fce51036d36e">addReference</a> ()=0</td></tr>
<tr class="memdesc:a07c9f6e71f0723bcf914fce51036d36e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#a07c9f6e71f0723bcf914fce51036d36e">More...</a><br /></td></tr>
<tr class="separator:a07c9f6e71f0723bcf914fce51036d36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78f9b745c6fb4114350cb1a26f3461d3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a78f9b745c6fb4114350cb1a26f3461d3">removeReference</a> ()=0</td></tr>
<tr class="memdesc:a78f9b745c6fb4114350cb1a26f3461d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#a78f9b745c6fb4114350cb1a26f3461d3">More...</a><br /></td></tr>
<tr class="separator:a78f9b745c6fb4114350cb1a26f3461d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a1570309c62a12c3ecfe7e695b9f21f"><td class="memItemLeft" align="right" valign="top">virtual int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a5a1570309c62a12c3ecfe7e695b9f21f">getReference</a> () const =0</td></tr>
<tr class="memdesc:a5a1570309c62a12c3ecfe7e695b9f21f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#a5a1570309c62a12c3ecfe7e695b9f21f">More...</a><br /></td></tr>
<tr class="separator:a5a1570309c62a12c3ecfe7e695b9f21f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3be62f992c1ff7218e2cf0fc0ba5b244"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a3be62f992c1ff7218e2cf0fc0ba5b244">release</a> ()=0</td></tr>
<tr class="memdesc:a3be62f992c1ff7218e2cf0fc0ba5b244"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implemented by derived implementation classes. <a href="#a3be62f992c1ff7218e2cf0fc0ba5b244">More...</a><br /></td></tr>
<tr class="separator:a3be62f992c1ff7218e2cf0fc0ba5b244"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fdd1448dcd86af96c5f1b79eb470e44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a4fdd1448dcd86af96c5f1b79eb470e44">getTaskManager</a> () const</td></tr>
<tr class="memdesc:a4fdd1448dcd86af96c5f1b79eb470e44"><td class="mdescLeft">&#160;</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="#a4fdd1448dcd86af96c5f1b79eb470e44">More...</a><br /></td></tr>
<tr class="separator:a4fdd1448dcd86af96c5f1b79eb470e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fa6ca56b758ea6b8be5c3acc8e89364"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a0fa6ca56b758ea6b8be5c3acc8e89364">setContextId</a> (<a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a> id)</td></tr>
<tr class="separator:a0fa6ca56b758ea6b8be5c3acc8e89364"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbc9d0b8d2a3c95f6c4579920f92d337"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#abbc9d0b8d2a3c95f6c4579920f92d337">getContextId</a> () const</td></tr>
<tr class="separator:abbc9d0b8d2a3c95f6c4579920f92d337"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a67864643cd2dfaf8483f8b7a75376bc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#a67864643cd2dfaf8483f8b7a75376bc7">mContextID</a></td></tr>
<tr class="memdesc:a67864643cd2dfaf8483f8b7a75376bc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context ID for profiler interface. <a href="#a67864643cd2dfaf8483f8b7a75376bc7">More...</a><br /></td></tr>
<tr class="separator:a67864643cd2dfaf8483f8b7a75376bc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af23fffec1e92c794d3ad73e9fc4fa974"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#af23fffec1e92c794d3ad73e9fc4fa974">mTm</a></td></tr>
<tr class="memdesc:af23fffec1e92c794d3ad73e9fc4fa974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Owning <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> instance. <a href="#af23fffec1e92c794d3ad73e9fc4fa974">More...</a><br /></td></tr>
<tr class="separator:af23fffec1e92c794d3ad73e9fc4fa974"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac4a43ca8ae513a20c1d61bc9aecfce89"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxBaseTask.html#ac4a43ca8ae513a20c1d61bc9aecfce89">PxTaskMgr</a></td></tr>
<tr class="separator:ac4a43ca8ae513a20c1d61bc9aecfce89"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class of all task types. </p>
<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. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a387b986ef3916322502452724d9ba582"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a387b986ef3916322502452724d9ba582">&#9670;&nbsp;</a></span>PxBaseTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">physx::PxBaseTask::PxBaseTask </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac3100494c97a23a88fcad8e28e222822"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3100494c97a23a88fcad8e28e222822">&#9670;&nbsp;</a></span>~PxBaseTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual physx::PxBaseTask::~PxBaseTask </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a07c9f6e71f0723bcf914fce51036d36e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07c9f6e71f0723bcf914fce51036d36e">&#9670;&nbsp;</a></span>addReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void physx::PxBaseTask::addReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented by derived implementation classes. </p>
<p>Implemented in <a class="el" href="classphysx_1_1PxLightCpuTask.html#a572d87fd23a65723d8e817f65e4681e6">physx::PxLightCpuTask</a>, and <a class="el" href="classphysx_1_1PxTask.html#ad3828abb4bd2237af28ecd08b972b1af">physx::PxTask</a>.</p>
<p class="reference">Referenced by <a class="el" href="classphysx_1_1PxLightCpuTask.html#a56ef764508a2bbc98d82bb6dbb09fa3e">physx::PxLightCpuTask::setContinuation()</a>.</p>
</div>
</div>
<a id="abbc9d0b8d2a3c95f6c4579920f92d337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbc9d0b8d2a3c95f6c4579920f92d337">&#9670;&nbsp;</a></span>getContextId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a> physx::PxBaseTask::getContextId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classphysx_1_1PxBaseTask.html#a67864643cd2dfaf8483f8b7a75376bc7">mContextID</a>.</p>
</div>
</div>
<a id="aa54eb4a1b50979436a797a62e383efee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa54eb4a1b50979436a797a62e383efee">&#9670;&nbsp;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* physx::PxBaseTask::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a user-provided task name for profiling purposes. </p>
<p>It does not have to be unique, but unique names are helpful.</p>
<dl class="section return"><dt>Returns</dt><dd>The name of this task </dd></dl>
</div>
</div>
<a id="a5a1570309c62a12c3ecfe7e695b9f21f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a1570309c62a12c3ecfe7e695b9f21f">&#9670;&nbsp;</a></span>getReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t physx::PxBaseTask::getReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented by derived implementation classes. </p>
<p>Implemented in <a class="el" href="classphysx_1_1PxLightCpuTask.html#a2e5ad3537b92242cc0bb81dfd70a82da">physx::PxLightCpuTask</a>, and <a class="el" href="classphysx_1_1PxTask.html#aae6b544fb79856864edbfaf83cce023a">physx::PxTask</a>.</p>
</div>
</div>
<a id="a4fdd1448dcd86af96c5f1b79eb470e44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fdd1448dcd86af96c5f1b79eb470e44">&#9670;&nbsp;</a></span>getTaskManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a>* physx::PxBaseTask::getTaskManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>
<p>Note, can return NULL if task was not submitted, or has been completed. </p>
<p class="reference">References <a class="el" href="classphysx_1_1PxBaseTask.html#af23fffec1e92c794d3ad73e9fc4fa974">mTm</a>.</p>
<p class="reference">Referenced by <a class="el" href="classphysx_1_1PxLightCpuTask.html#a2ae16158861b04543919fdc456bb4559">physx::PxLightCpuTask::setContinuation()</a>.</p>
</div>
</div>
<a id="a3be62f992c1ff7218e2cf0fc0ba5b244"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3be62f992c1ff7218e2cf0fc0ba5b244">&#9670;&nbsp;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void physx::PxBaseTask::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented by derived implementation classes. </p>
<p>A task may assume in its <a class="el" href="classphysx_1_1PxBaseTask.html#a3be62f992c1ff7218e2cf0fc0ba5b244" 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>
<p>Implemented in <a class="el" href="classphysx_1_1PxLightCpuTask.html#aea23c57ffecb54f397089de1f3b0ad20">physx::PxLightCpuTask</a>, and <a class="el" href="classphysx_1_1PxTask.html#acedcca7b8305c3ad519e537ab307c39a">physx::PxTask</a>.</p>
</div>
</div>
<a id="a78f9b745c6fb4114350cb1a26f3461d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78f9b745c6fb4114350cb1a26f3461d3">&#9670;&nbsp;</a></span>removeReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void physx::PxBaseTask::removeReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented by derived implementation classes. </p>
<p>Implemented in <a class="el" href="classphysx_1_1PxLightCpuTask.html#a4f847956e5ba51a36bbb3ced5bb15a6c">physx::PxLightCpuTask</a>, and <a class="el" href="classphysx_1_1PxTask.html#a097c70f1419ad4991ef876ddd9a74d48">physx::PxTask</a>.</p>
<p class="reference">Referenced by <a class="el" href="classphysx_1_1PxLightCpuTask.html#aea23c57ffecb54f397089de1f3b0ad20">physx::PxLightCpuTask::release()</a>.</p>
</div>
</div>
<a id="a517a16d9dc630c9274a7564deb3a7e4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a517a16d9dc630c9274a7564deb3a7e4a">&#9670;&nbsp;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void physx::PxBaseTask::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The user-implemented run method where the task's work should be performed. </p>
<p><a class="el" href="classphysx_1_1PxBaseTask.html#a517a16d9dc630c9274a7564deb3a7e4a" 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>
</div>
</div>
<a id="a0fa6ca56b758ea6b8be5c3acc8e89364"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fa6ca56b758ea6b8be5c3acc8e89364">&#9670;&nbsp;</a></span>setContextId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void physx::PxBaseTask::setContextId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a>&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classphysx_1_1PxBaseTask.html#a67864643cd2dfaf8483f8b7a75376bc7">mContextID</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="ac4a43ca8ae513a20c1d61bc9aecfce89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4a43ca8ae513a20c1d61bc9aecfce89">&#9670;&nbsp;</a></span>PxTaskMgr</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class PxTaskMgr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a67864643cd2dfaf8483f8b7a75376bc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67864643cd2dfaf8483f8b7a75376bc7">&#9670;&nbsp;</a></span>mContextID</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacephysx.html#a8ee037dcecf7198800e1f302795c10ee">PxU64</a> physx::PxBaseTask::mContextID</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Context ID for profiler interface. </p>
<p class="reference">Referenced by <a class="el" href="classphysx_1_1PxBaseTask.html#abbc9d0b8d2a3c95f6c4579920f92d337">getContextId()</a>, and <a class="el" href="classphysx_1_1PxBaseTask.html#a0fa6ca56b758ea6b8be5c3acc8e89364">setContextId()</a>.</p>
</div>
</div>
<a id="af23fffec1e92c794d3ad73e9fc4fa974"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af23fffec1e92c794d3ad73e9fc4fa974">&#9670;&nbsp;</a></span>mTm</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a>* physx::PxBaseTask::mTm</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </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 class="reference">Referenced by <a class="el" href="classphysx_1_1PxTask.html#ad3828abb4bd2237af28ecd08b972b1af">physx::PxTask::addReference()</a>, <a class="el" href="classphysx_1_1PxLightCpuTask.html#a572d87fd23a65723d8e817f65e4681e6">physx::PxLightCpuTask::addReference()</a>, <a class="el" href="classphysx_1_1PxTask.html#aa417f4d080c31178ff6ded2c92b8bb05">physx::PxTask::finishBefore()</a>, <a class="el" href="classphysx_1_1PxTask.html#aae6b544fb79856864edbfaf83cce023a">physx::PxTask::getReference()</a>, <a class="el" href="classphysx_1_1PxBaseTask.html#a4fdd1448dcd86af96c5f1b79eb470e44">getTaskManager()</a>, <a class="el" href="classphysx_1_1PxTask.html#acedcca7b8305c3ad519e537ab307c39a">physx::PxTask::release()</a>, <a class="el" href="classphysx_1_1PxTask.html#a097c70f1419ad4991ef876ddd9a74d48">physx::PxTask::removeReference()</a>, <a class="el" href="classphysx_1_1PxLightCpuTask.html#a4f847956e5ba51a36bbb3ced5bb15a6c">physx::PxLightCpuTask::removeReference()</a>, <a class="el" href="classphysx_1_1PxLightCpuTask.html#a56ef764508a2bbc98d82bb6dbb09fa3e">physx::PxLightCpuTask::setContinuation()</a>, <a class="el" href="classphysx_1_1PxTask.html#a5ea294d819b903a507efe1358f86b8cd">physx::PxTask::startAfter()</a>, and <a class="el" href="classphysx_1_1PxLightCpuTask.html#a0d9094c15329d367cff90b95e0bdcf88">physx::PxLightCpuTask::~PxLightCpuTask()</a>.</p>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacephysx.html">physx</a></li><li class="navelem"><a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink