223 lines
11 KiB
HTML
223 lines
11 KiB
HTML
<!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::PxCpuDispatcher 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&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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classphysx_1_1PxCpuDispatcher.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> |
|
|
<a href="classphysx_1_1PxCpuDispatcher-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">physx::PxCpuDispatcher Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK.
|
|
<a href="classphysx_1_1PxCpuDispatcher.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PxCpuDispatcher_8h_source.html">PxCpuDispatcher.h</a>></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:a0030e67bed850b70d6725775e5c3ce3c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxCpuDispatcher.html#a0030e67bed850b70d6725775e5c3ce3c">submitTask</a> (<a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a> &task)=0</td></tr>
|
|
<tr class="memdesc:a0030e67bed850b70d6725775e5c3ce3c"><td class="mdescLeft"> </td><td class="mdescRight">Called by the TaskManager when a task is to be queued for execution. <a href="#a0030e67bed850b70d6725775e5c3ce3c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0030e67bed850b70d6725775e5c3ce3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55b03b2db9de4be06f5eace3e43f4ebc"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxCpuDispatcher.html#a55b03b2db9de4be06f5eace3e43f4ebc">getWorkerCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a55b03b2db9de4be06f5eace3e43f4ebc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of available worker threads for this dispatcher. <a href="#a55b03b2db9de4be06f5eace3e43f4ebc">More...</a><br /></td></tr>
|
|
<tr class="separator:a55b03b2db9de4be06f5eace3e43f4ebc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a973d20d06b2a14c05facd7b644c78088"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxCpuDispatcher.html#a973d20d06b2a14c05facd7b644c78088">~PxCpuDispatcher</a> ()</td></tr>
|
|
<tr class="separator:a973d20d06b2a14c05facd7b644c78088"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK. </p>
|
|
<p>A typical implementation would for example use a thread pool with the dispatcher pushing tasks onto worker thread queues or a global queue.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types. ">PxBaseTask</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classphysx_1_1PxTask.html" title="A PxBaseTask implementation with deferred execution and full dependencies. ">PxTask</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classphysx_1_1PxTaskManager.html" title="The PxTaskManager interface. ">PxTaskManager</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a973d20d06b2a14c05facd7b644c78088"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a973d20d06b2a14c05facd7b644c78088">◆ </a></span>~PxCpuDispatcher()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual physx::PxCpuDispatcher::~PxCpuDispatcher </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="a55b03b2db9de4be06f5eace3e43f4ebc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55b03b2db9de4be06f5eace3e43f4ebc">◆ </a></span>getWorkerCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint32_t physx::PxCpuDispatcher::getWorkerCount </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>Returns the number of available worker threads for this dispatcher. </p>
|
|
<p>The SDK will use this count to control how many tasks are submitted. By matching the number of tasks with the number of execution units task overhead can be reduced. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0030e67bed850b70d6725775e5c3ce3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0030e67bed850b70d6725775e5c3ce3c">◆ </a></span>submitTask()</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::PxCpuDispatcher::submitTask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classphysx_1_1PxBaseTask.html">PxBaseTask</a> & </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 TaskManager when a task is to be queued for execution. </p>
|
|
<p>Upon receiving a task, the dispatcher should schedule the task to run when resource is available. After the task has been run, it should call the release() method and discard it's pointer.</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 run.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classphysx_1_1PxBaseTask.html" title="Base class of all task types. ">PxBaseTask</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PxCpuDispatcher_8h_source.html">PxCpuDispatcher.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_1PxCpuDispatcher.html">PxCpuDispatcher</a></li>
|
|
<li class="footer">Copyright © 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>
|