diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxTaskManager.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxTaskManager.html | 581 |
1 files changed, 581 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxTaskManager.html b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxTaskManager.html new file mode 100644 index 00000000..5813d58e --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxTaskManager.html @@ -0,0 +1,581 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxTaskManager 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> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </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_1PxTaskManager.html">PxTaskManager</a> + </div> +<div class="contents"> +<h1>physx::PxTaskManager Class Reference</h1><!-- doxytag: class="physx::PxTaskManager" -->The <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> interface. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxTaskManager_8h-source.html">PxTaskManager.h</a>></code> +<p> + +<p> +<a href="classphysx_1_1PxTaskManager-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#c391319b63678f793dc6800b5ecda801">setCpuDispatcher</a> (<a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> &ref)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the user-provided dispatcher object for CPU tasks. <a href="#c391319b63678f793dc6800b5ecda801"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#2222879a9e1f258c3d46579f56d65275">setGpuDispatcher</a> (<a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a> &ref)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the user-provided dispatcher object for GPU tasks. <a href="#2222879a9e1f258c3d46579f56d65275"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#4d68c14745bfd85c745b58528b39db26">getCpuDispatcher</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the user-provided dispatcher object for CPU tasks. <a href="#4d68c14745bfd85c745b58528b39db26"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#3b8273fb73c75e7425fd5a0687055641">getGpuDispatcher</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the user-provided dispatcher object for GPU tasks. <a href="#3b8273fb73c75e7425fd5a0687055641"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#79606deb50e9eb500c5febb44ba1e764">resetDependencies</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset any dependencies between Tasks. <a href="#79606deb50e9eb500c5febb44ba1e764"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#ab9b613b731eb4cc5007db33fc801017">startSimulation</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the owning scene to start the task graph. <a href="#ab9b613b731eb4cc5007db33fc801017"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#6008ca7efcd7fa4a77d10f0606e3f17a">stopSimulation</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the owning scene at the end of a simulation step to synchronize the <a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a>. <a href="#6008ca7efcd7fa4a77d10f0606e3f17a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#36a746ff81e26d57195ebfdd0141e912">taskCompleted</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &task)=0</td></tr> + +<tr><td class="mdescLeft"> </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="#36a746ff81e26d57195ebfdd0141e912"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#c3b7602900e8f50780d518ab3d0a17d0">getNamedTask</a> (const char *name)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a task by name. <a href="#c3b7602900e8f50780d518ab3d0a17d0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#f1a81608f80d92d19520aa9dba2dca23">submitNamedTask</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> *task, const char *name, <a class="el" href="structphysx_1_1PxTaskType.html#e5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> type=PxTaskType::TT_CPU)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Submit a task with a unique name. <a href="#f1a81608f80d92d19520aa9dba2dca23"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#2f942d2ad1ea34dd74e7127cd72e20ae">submitUnnamedTask</a> (<a class="el" href="classphysx_1_1PxTask.html">PxTask</a> &task, <a class="el" href="structphysx_1_1PxTaskType.html#e5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> type=PxTaskType::TT_CPU)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Submit an unnamed task. <a href="#2f942d2ad1ea34dd74e7127cd72e20ae"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classphysx_1_1PxTask.html">PxTask</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#62b0f1892459275040db9ce8e274ca14">getTaskFromID</a> (<a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> id)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a task given a task ID. <a href="#62b0f1892459275040db9ce8e274ca14"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#c368283919f97fdb6918c7f217718db2">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </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="#c368283919f97fdb6918c7f217718db2"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classphysx_1_1PxTaskManager.html">PxTaskManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#940fded6abf31baf0dd31b01b2b86c36">createTaskManager</a> (<a class="el" href="classPxErrorCallback.html">PxErrorCallback</a> &errorCallback, <a class="el" href="classphysx_1_1PxCpuDispatcher.html">PxCpuDispatcher</a> *=0, <a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a> *=0)</td></tr> + +<tr><td class="mdescLeft"> </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="#940fded6abf31baf0dd31b01b2b86c36"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#cc2dfad2e3256187f977095071f9be30">~PxTaskManager</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#f33eb2b61a29f3a4d62f211a78c46f47">PxBaseTask</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#09f24c51c8921a6866cfb6dd214e1282">PxTask</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#4635f476e861159685a7a960660a5842">PxLightCpuTask</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxTaskManager.html#7f49a59cfb28fd74ba8601e2d0d2d35a">PxGpuWorkerThread</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The <a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface.">PxTaskManager</a> interface. +<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 it's 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="see" compact><dt><b>See also:</b></dt><dd>CpuDispatcher <p> +<a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="cc2dfad2e3256187f977095071f9be30"></a><!-- doxytag: member="physx::PxTaskManager::~PxTaskManager" ref="cc2dfad2e3256187f977095071f9be30" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual physx::PxTaskManager::~PxTaskManager </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="940fded6abf31baf0dd31b01b2b86c36"></a><!-- doxytag: member="physx::PxTaskManager::createTaskManager" ref="940fded6abf31baf0dd31b01b2b86c36" args="(PxErrorCallback &errorCallback, PxCpuDispatcher *=0, PxGpuDispatcher *=0)" --> +<div class="memitem"> +<div class="memproto"> + <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> & </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> * </td> + <td class="paramname"> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a> * </td> + <td class="paramname"> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></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><p> +<a class="anchor" name="4d68c14745bfd85c745b58528b39db26"></a><!-- doxytag: member="physx::PxTaskManager::getCpuDispatcher" ref="4d68c14745bfd85c745b58528b39db26" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <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<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the user-provided dispatcher object for CPU tasks. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The CPU dispatcher object.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>CpuDispatcher </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3b8273fb73c75e7425fd5a0687055641"></a><!-- doxytag: member="physx::PxTaskManager::getGpuDispatcher" ref="3b8273fb73c75e7425fd5a0687055641" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a>* physx::PxTaskManager::getGpuDispatcher </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the user-provided dispatcher object for GPU tasks. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The GPU dispatcher object.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c3b7602900e8f50780d518ab3d0a17d0"></a><!-- doxytag: member="physx::PxTaskManager::getNamedTask" ref="c3b7602900e8f50780d518ab3d0a17d0" args="(const char *name)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::getNamedTask </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve a task by name. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>name</em> </td><td>The unique name of a task </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl> + +</div> +</div><p> +<a class="anchor" name="62b0f1892459275040db9ce8e274ca14"></a><!-- doxytag: member="physx::PxTaskManager::getTaskFromID" ref="62b0f1892459275040db9ce8e274ca14" args="(PxTaskID id)=0" --> +<div class="memitem"> +<div class="memproto"> + <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#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> </td> + <td class="paramname"> <em>id</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve a task given a task ID. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>id</em> </td><td>The ID of the task to return, a valid ID must be passed or results are undefined</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The task associated with the ID </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c368283919f97fdb6918c7f217718db2"></a><!-- doxytag: member="physx::PxTaskManager::release" ref="c368283919f97fdb6918c7f217718db2" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void physx::PxTaskManager::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></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><p> +<a class="anchor" name="79606deb50e9eb500c5febb44ba1e764"></a><!-- doxytag: member="physx::PxTaskManager::resetDependencies" ref="79606deb50e9eb500c5febb44ba1e764" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void physx::PxTaskManager::resetDependencies </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reset any dependencies between Tasks. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Will be called at the start of every frame before tasks are submitted.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></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><p> +<a class="anchor" name="c391319b63678f793dc6800b5ecda801"></a><!-- doxytag: member="physx::PxTaskManager::setCpuDispatcher" ref="c391319b63678f793dc6800b5ecda801" args="(PxCpuDispatcher &ref)=0" --> +<div class="memitem"> +<div class="memproto"> + <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> & </td> + <td class="paramname"> <em>ref</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the user-provided dispatcher object for CPU tasks. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ref</em> </td><td>The dispatcher object.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>CpuDispatcher </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2222879a9e1f258c3d46579f56d65275"></a><!-- doxytag: member="physx::PxTaskManager::setGpuDispatcher" ref="2222879a9e1f258c3d46579f56d65275" args="(PxGpuDispatcher &ref)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void physx::PxTaskManager::setGpuDispatcher </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classphysx_1_1PxGpuDispatcher.html">PxGpuDispatcher</a> & </td> + <td class="paramname"> <em>ref</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the user-provided dispatcher object for GPU tasks. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>ref</em> </td><td>The dispatcher object.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ab9b613b731eb4cc5007db33fc801017"></a><!-- doxytag: member="physx::PxTaskManager::startSimulation" ref="ab9b613b731eb4cc5007db33fc801017" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void physx::PxTaskManager::startSimulation </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called by the owning scene to start the task graph. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>All tasks with with ref count of 1 will be dispatched.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></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><p> +<a class="anchor" name="6008ca7efcd7fa4a77d10f0606e3f17a"></a><!-- doxytag: member="physx::PxTaskManager::stopSimulation" ref="6008ca7efcd7fa4a77d10f0606e3f17a" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void physx::PxTaskManager::stopSimulation </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called by the owning scene at the end of a simulation step to synchronize the <a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a>. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classphysx_1_1PxGpuDispatcher.html" title="A GpuTask dispatcher.">PxGpuDispatcher</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f1a81608f80d92d19520aa9dba2dca23"></a><!-- doxytag: member="physx::PxTaskManager::submitNamedTask" ref="f1a81608f80d92d19520aa9dba2dca23" args="(PxTask *task, const char *name, PxTaskType::Enum type=PxTaskType::TT_CPU)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::submitNamedTask </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classphysx_1_1PxTask.html">PxTask</a> * </td> + <td class="paramname"> <em>task</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </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#e5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> </td> + <td class="paramname"> <em>type</em> = <code>PxTaskType::TT_CPU</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Submit a task with a unique name. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>task</em> </td><td>The task to be executed </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>name</em> </td><td>The unique name of a task </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>type</em> </td><td>The type of the task (default TT_CPU) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2f942d2ad1ea34dd74e7127cd72e20ae"></a><!-- doxytag: member="physx::PxTaskManager::submitUnnamedTask" ref="2f942d2ad1ea34dd74e7127cd72e20ae" args="(PxTask &task, PxTaskType::Enum type=PxTaskType::TT_CPU)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespacephysx.html#7a08e207472f32da1e024056f32d64a2">PxTaskID</a> physx::PxTaskManager::submitUnnamedTask </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classphysx_1_1PxTask.html">PxTask</a> & </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#e5545e371cf86793e4a0d395e4ebdb6b">PxTaskType::Enum</a> </td> + <td class="paramname"> <em>type</em> = <code>PxTaskType::TT_CPU</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Submit an unnamed task. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>task</em> </td><td>The task to be executed </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>type</em> </td><td>The type of the task (default TT_CPU)</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ID of the task with that name, or TT_NOT_PRESENT if not found </dd></dl> + +</div> +</div><p> +<a class="anchor" name="36a746ff81e26d57195ebfdd0141e912"></a><!-- doxytag: member="physx::PxTaskManager::taskCompleted" ref="36a746ff81e26d57195ebfdd0141e912" args="(PxTask &task)=0" --> +<div class="memitem"> +<div class="memproto"> + <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> & </td> + <td class="paramname"> <em>task</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></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 compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>task</em> </td><td>The task which has been completed </td></tr> + </table> +</dl> + +<p>Referenced by <a class="el" href="PxTask_8h-source.html#l00144">physx::PxTask::release()</a>.</p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="f33eb2b61a29f3a4d62f211a78c46f47"></a><!-- doxytag: member="physx::PxTaskManager::PxBaseTask" ref="f33eb2b61a29f3a4d62f211a78c46f47" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="7f49a59cfb28fd74ba8601e2d0d2d35a"></a><!-- doxytag: member="physx::PxTaskManager::PxGpuWorkerThread" ref="7f49a59cfb28fd74ba8601e2d0d2d35a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class PxGpuWorkerThread<code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="4635f476e861159685a7a960660a5842"></a><!-- doxytag: member="physx::PxTaskManager::PxLightCpuTask" ref="4635f476e861159685a7a960660a5842" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classphysx_1_1PxLightCpuTask.html">PxLightCpuTask</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="09f24c51c8921a6866cfb6dd214e1282"></a><!-- doxytag: member="physx::PxTaskManager::PxTask" ref="09f24c51c8921a6866cfb6dd214e1282" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classphysx_1_1PxTask.html">PxTask</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<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></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 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> |