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

689 lines
35 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::PxTaskManager 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_1PxTaskManager.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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classphysx_1_1PxTaskManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">physx::PxTaskManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> interface.
<a href="classphysx_1_1PxTaskManager.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxTaskManager_8h_source.html">PxTaskManager.h</a>&gt;</code></p>
<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:ac391319b63678f793dc6800b5ecda801"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#ac391319b63678f793dc6800b5ecda801">setCpuDispatcher</a> (<a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> &amp;ref)=0</td></tr>
<tr class="memdesc:ac391319b63678f793dc6800b5ecda801"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the user-provided dispatcher object for CPU tasks. <a href="#ac391319b63678f793dc6800b5ecda801">More...</a><br /></td></tr>
<tr class="separator:ac391319b63678f793dc6800b5ecda801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d68c14745bfd85c745b58528b39db26"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a4d68c14745bfd85c745b58528b39db26">getCpuDispatcher</a> () const =0</td></tr>
<tr class="memdesc:a4d68c14745bfd85c745b58528b39db26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the user-provided dispatcher object for CPU tasks. <a href="#a4d68c14745bfd85c745b58528b39db26">More...</a><br /></td></tr>
<tr class="separator:a4d68c14745bfd85c745b58528b39db26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79606deb50e9eb500c5febb44ba1e764"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a79606deb50e9eb500c5febb44ba1e764">resetDependencies</a> ()=0</td></tr>
<tr class="memdesc:a79606deb50e9eb500c5febb44ba1e764"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset any dependencies between Tasks. <a href="#a79606deb50e9eb500c5febb44ba1e764">More...</a><br /></td></tr>
<tr class="separator:a79606deb50e9eb500c5febb44ba1e764"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab9b613b731eb4cc5007db33fc801017"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#aab9b613b731eb4cc5007db33fc801017">startSimulation</a> ()=0</td></tr>
<tr class="memdesc:aab9b613b731eb4cc5007db33fc801017"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by the owning scene to start the task graph. <a href="#aab9b613b731eb4cc5007db33fc801017">More...</a><br /></td></tr>
<tr class="separator:aab9b613b731eb4cc5007db33fc801017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6008ca7efcd7fa4a77d10f0606e3f17a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a6008ca7efcd7fa4a77d10f0606e3f17a">stopSimulation</a> ()=0</td></tr>
<tr class="memdesc:a6008ca7efcd7fa4a77d10f0606e3f17a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by the owning scene at the end of a simulation step. <a href="#a6008ca7efcd7fa4a77d10f0606e3f17a">More...</a><br /></td></tr>
<tr class="separator:a6008ca7efcd7fa4a77d10f0606e3f17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36a746ff81e26d57195ebfdd0141e912"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a36a746ff81e26d57195ebfdd0141e912">taskCompleted</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &amp;task)=0</td></tr>
<tr class="memdesc:a36a746ff81e26d57195ebfdd0141e912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by the worker threads to inform the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> that a task has completed processing. <a href="#a36a746ff81e26d57195ebfdd0141e912">More...</a><br /></td></tr>
<tr class="separator:a36a746ff81e26d57195ebfdd0141e912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3b7602900e8f50780d518ab3d0a17d0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#ac3b7602900e8f50780d518ab3d0a17d0">getNamedTask</a> (const char *name)=0</td></tr>
<tr class="memdesc:ac3b7602900e8f50780d518ab3d0a17d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a task by name. <a href="#ac3b7602900e8f50780d518ab3d0a17d0">More...</a><br /></td></tr>
<tr class="separator:ac3b7602900e8f50780d518ab3d0a17d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1a81608f80d92d19520aa9dba2dca23"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#af1a81608f80d92d19520aa9dba2dca23">submitNamedTask</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> *task, const char *name, <a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> type=<a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6ba27553f47b12c277e0cb685240cb8b9b3">PxTaskType::TT_CPU</a>)=0</td></tr>
<tr class="memdesc:af1a81608f80d92d19520aa9dba2dca23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit a task with a unique name. <a href="#af1a81608f80d92d19520aa9dba2dca23">More...</a><br /></td></tr>
<tr class="separator:af1a81608f80d92d19520aa9dba2dca23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f942d2ad1ea34dd74e7127cd72e20ae"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a2f942d2ad1ea34dd74e7127cd72e20ae">submitUnnamedTask</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &amp;task, <a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> type=<a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6ba27553f47b12c277e0cb685240cb8b9b3">PxTaskType::TT_CPU</a>)=0</td></tr>
<tr class="memdesc:a2f942d2ad1ea34dd74e7127cd72e20ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit an unnamed task. <a href="#a2f942d2ad1ea34dd74e7127cd72e20ae">More...</a><br /></td></tr>
<tr class="separator:a2f942d2ad1ea34dd74e7127cd72e20ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b0f1892459275040db9ce8e274ca14"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classphysx_1_1PxTask.html">PxTask</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a62b0f1892459275040db9ce8e274ca14">getTaskFromID</a> (<a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a> id)=0</td></tr>
<tr class="memdesc:a62b0f1892459275040db9ce8e274ca14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a task given a task ID. <a href="#a62b0f1892459275040db9ce8e274ca14">More...</a><br /></td></tr>
<tr class="separator:a62b0f1892459275040db9ce8e274ca14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac368283919f97fdb6918c7f217718db2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#ac368283919f97fdb6918c7f217718db2">release</a> ()=0</td></tr>
<tr class="memdesc:ac368283919f97fdb6918c7f217718db2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> object, referenced dispatchers will not be released. <a href="#ac368283919f97fdb6918c7f217718db2">More...</a><br /></td></tr>
<tr class="separator:ac368283919f97fdb6918c7f217718db2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4f3449671ec8b26f1ae587844b678fa7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a4f3449671ec8b26f1ae587844b678fa7">createTaskManager</a> (<a class="el" href="classPxErrorCallback.html">PxErrorCallback</a> &amp;errorCallback, <a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> *=0)</td></tr>
<tr class="memdesc:a4f3449671ec8b26f1ae587844b678fa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> instance with the given [optional] dispatchers. <a href="#a4f3449671ec8b26f1ae587844b678fa7">More...</a><br /></td></tr>
<tr class="separator:a4f3449671ec8b26f1ae587844b678fa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:acc2dfad2e3256187f977095071f9be30"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#acc2dfad2e3256187f977095071f9be30">~PxTaskManager</a> ()</td></tr>
<tr class="separator:acc2dfad2e3256187f977095071f9be30"><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:af33eb2b61a29f3a4d62f211a78c46f47"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#af33eb2b61a29f3a4d62f211a78c46f47">PxBaseTask</a></td></tr>
<tr class="separator:af33eb2b61a29f3a4d62f211a78c46f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f24c51c8921a6866cfb6dd214e1282"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a09f24c51c8921a6866cfb6dd214e1282">PxTask</a></td></tr>
<tr class="separator:a09f24c51c8921a6866cfb6dd214e1282"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4635f476e861159685a7a960660a5842"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#a4635f476e861159685a7a960660a5842">PxLightCpuTask</a></td></tr>
<tr class="separator:a4635f476e861159685a7a960660a5842"><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>The <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> interface. </p>
<p>A <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> instance holds references to user-provided dispatcher objects, when tasks are submitted the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> routes them to the appropriate dispatcher and handles task profiling if enabled. Users should not implement the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> interface, the SDK creates its own concrete <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> object per-scene which users can configure by passing dispatcher objects into the <a class="el" href="classPxSceneDesc.html" title="Descriptor class for scenes. See PxScene. ">PxSceneDesc</a>.</p>
<dl class="section see"><dt>See also</dt><dd>CpuDispatcher </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acc2dfad2e3256187f977095071f9be30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc2dfad2e3256187f977095071f9be30">&#9670;&nbsp;</a></span>~PxTaskManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual physx::PxTaskManager::~PxTaskManager </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">protected</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="a4f3449671ec8b26f1ae587844b678fa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f3449671ec8b26f1ae587844b678fa7">&#9670;&nbsp;</a></span>createTaskManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a>* physx::PxTaskManager::createTaskManager </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxErrorCallback.html">PxErrorCallback</a> &amp;&#160;</td>
<td class="paramname"><em>errorCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> *&#160;</td>
<td class="paramname"> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> instance with the given [optional] dispatchers. </p>
</div>
</div>
<a id="a4d68c14745bfd85c745b58528b39db26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d68c14745bfd85c745b58528b39db26">&#9670;&nbsp;</a></span>getCpuDispatcher()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a>* physx::PxTaskManager::getCpuDispatcher </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>Get the user-provided dispatcher object for CPU tasks. </p>
<dl class="section return"><dt>Returns</dt><dd>The CPU dispatcher object.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>CpuDispatcher </dd></dl>
</div>
</div>
<a id="ac3b7602900e8f50780d518ab3d0a17d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3b7602900e8f50780d518ab3d0a17d0">&#9670;&nbsp;</a></span>getNamedTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::getNamedTask </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></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>Retrieve a task by name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The unique name of a task </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl>
</div>
</div>
<a id="a62b0f1892459275040db9ce8e274ca14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b0f1892459275040db9ce8e274ca14">&#9670;&nbsp;</a></span>getTaskFromID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classphysx_1_1PxTask.html">PxTask</a>* physx::PxTaskManager::getTaskFromID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a task given a task ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>The ID of the task to return, a valid ID must be passed or results are undefined</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The task associated with the ID </dd></dl>
</div>
</div>
<a id="ac368283919f97fdb6918c7f217718db2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac368283919f97fdb6918c7f217718db2">&#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::PxTaskManager::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>Release the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> object, referenced dispatchers will not be released. </p>
</div>
</div>
<a id="a79606deb50e9eb500c5febb44ba1e764"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79606deb50e9eb500c5febb44ba1e764">&#9670;&nbsp;</a></span>resetDependencies()</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::PxTaskManager::resetDependencies </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>Reset any dependencies between Tasks. </p>
<dl class="section note"><dt>Note</dt><dd>Will be called at the start of every frame before tasks are submitted.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies. ">PxTask</a> </dd></dl>
</div>
</div>
<a id="ac391319b63678f793dc6800b5ecda801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac391319b63678f793dc6800b5ecda801">&#9670;&nbsp;</a></span>setCpuDispatcher()</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::PxTaskManager::setCpuDispatcher </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> &amp;&#160;</td>
<td class="paramname"><em>ref</em></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>Set the user-provided dispatcher object for CPU tasks. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The dispatcher object.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>CpuDispatcher </dd></dl>
</div>
</div>
<a id="aab9b613b731eb4cc5007db33fc801017"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab9b613b731eb4cc5007db33fc801017">&#9670;&nbsp;</a></span>startSimulation()</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::PxTaskManager::startSimulation </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>Called by the owning scene to start the task graph. </p>
<dl class="section note"><dt>Note</dt><dd>All tasks with with ref count of 1 will be dispatched.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies. ">PxTask</a> </dd></dl>
</div>
</div>
<a id="a6008ca7efcd7fa4a77d10f0606e3f17a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6008ca7efcd7fa4a77d10f0606e3f17a">&#9670;&nbsp;</a></span>stopSimulation()</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::PxTaskManager::stopSimulation </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>Called by the owning scene at the end of a simulation step. </p>
</div>
</div>
<a id="af1a81608f80d92d19520aa9dba2dca23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1a81608f80d92d19520aa9dba2dca23">&#9670;&nbsp;</a></span>submitNamedTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::submitNamedTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxTask.html">PxTask</a> *&#160;</td>
<td class="paramname"><em>task</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a>&#160;</td>
<td class="paramname"><em>type</em> = <code><a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6ba27553f47b12c277e0cb685240cb8b9b3">PxTaskType::TT_CPU</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Submit a task with a unique name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">task</td><td>The task to be executed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The unique name of a task </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the task (default TT_CPU) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl>
</div>
</div>
<a id="a2f942d2ad1ea34dd74e7127cd72e20ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f942d2ad1ea34dd74e7127cd72e20ae">&#9670;&nbsp;</a></span>submitUnnamedTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacephysx.html#a7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::submitUnnamedTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &amp;&#160;</td>
<td class="paramname"><em>task</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a>&#160;</td>
<td class="paramname"><em>type</em> = <code><a class="el" href="structphysx_1_1PxTaskType.html#ae5545e371cf86793e4a0d395e4ebdb6ba27553f47b12c277e0cb685240cb8b9b3">PxTaskType::TT_CPU</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Submit an unnamed task. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">task</td><td>The task to be executed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the task (default TT_CPU)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl>
</div>
</div>
<a id="a36a746ff81e26d57195ebfdd0141e912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36a746ff81e26d57195ebfdd0141e912">&#9670;&nbsp;</a></span>taskCompleted()</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::PxTaskManager::taskCompleted </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &amp;&#160;</td>
<td class="paramname"><em>task</em></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>Called by the worker threads to inform the <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> that a task has completed processing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">task</td><td>The task which has been completed </td></tr>
</table>
</dd>
</dl>
<p class="reference">Referenced by <a class="el" href="classphysx_1_1PxTask.html#acedcca7b8305c3ad519e537ab307c39a">physx::PxTask::release()</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="af33eb2b61a29f3a4d62f211a78c46f47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af33eb2b61a29f3a4d62f211a78c46f47">&#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">friend class <a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a></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>
<a id="a4635f476e861159685a7a960660a5842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4635f476e861159685a7a960660a5842">&#9670;&nbsp;</a></span>PxLightCpuTask</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classphysx_1_1PxLightCpuTask.html">PxLightCpuTask</a></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>
<a id="a09f24c51c8921a6866cfb6dd214e1282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09f24c51c8921a6866cfb6dd214e1282">&#9670;&nbsp;</a></span>PxTask</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classphysx_1_1PxTask.html">PxTask</a></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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxTaskManager_8h_source.html">PxTaskManager.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_1PxTaskManager.html">PxTaskManager</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