cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: JobSystemThreadPool 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_job_system_thread_pool.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_job_system_thread_pool-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">JobSystemThreadPool Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_job_system_thread_pool_8h_source.html">JobSystemThreadPool.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for JobSystemThreadPool:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_job_system_thread_pool.png" usemap="#JobSystemThreadPool_map" alt=""/>
  <map id="JobSystemThreadPool_map" name="JobSystemThreadPool_map">
<area href="class_job_system_with_barrier.html" alt="JobSystemWithBarrier" shape="rect" coords="0,112,138,136"/>
<area href="class_job_system.html" alt="JobSystem" shape="rect" coords="0,56,138,80"/>
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,138,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a380fb336206bb8188b5a68979ac432ab" id="r_a380fb336206bb8188b5a68979ac432ab"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> = function&lt;void(int)&gt;</td></tr>
<tr class="memdesc:a380fb336206bb8188b5a68979ac432ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions to call when a thread is initialized or exits, must be set before calling <a class="el" href="#ad8d40e63f28b99fcffdbb2e237864482">Init()</a>  <br /></td></tr>
<tr class="separator:a380fb336206bb8188b5a68979ac432ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_job_system')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
<tr class="memitem:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system" id="r_ae31ef61a509934f03d4705aec19c61f5"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> = function&lt;void()&gt;</td></tr>
<tr class="memdesc:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function of the job.  <br /></td></tr>
<tr class="separator:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adaccd4fc1faa23f3883c2d16e32d0382" id="r_adaccd4fc1faa23f3883c2d16e32d0382"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adaccd4fc1faa23f3883c2d16e32d0382">JobSystemThreadPool</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers, int inNumThreads=-1)</td></tr>
<tr class="separator:adaccd4fc1faa23f3883c2d16e32d0382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf4a8888977261556ec87fea4ceb64aa" id="r_acf4a8888977261556ec87fea4ceb64aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf4a8888977261556ec87fea4ceb64aa">JobSystemThreadPool</a> ()=default</td></tr>
<tr class="separator:acf4a8888977261556ec87fea4ceb64aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56f9475443e5598d7176d9b94da6bdff" id="r_a56f9475443e5598d7176d9b94da6bdff"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56f9475443e5598d7176d9b94da6bdff">~JobSystemThreadPool</a> () override</td></tr>
<tr class="separator:a56f9475443e5598d7176d9b94da6bdff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c1157b283998781be0e2164e5639ba3" id="r_a7c1157b283998781be0e2164e5639ba3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c1157b283998781be0e2164e5639ba3">SetThreadInitFunction</a> (const <a class="el" href="#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;inInitFunction)</td></tr>
<tr class="separator:a7c1157b283998781be0e2164e5639ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b29fcac624eeac4e5219158ef0c4912" id="r_a2b29fcac624eeac4e5219158ef0c4912"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2b29fcac624eeac4e5219158ef0c4912">SetThreadExitFunction</a> (const <a class="el" href="#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;inExitFunction)</td></tr>
<tr class="separator:a2b29fcac624eeac4e5219158ef0c4912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8d40e63f28b99fcffdbb2e237864482" id="r_ad8d40e63f28b99fcffdbb2e237864482"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad8d40e63f28b99fcffdbb2e237864482">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers, int inNumThreads=-1)</td></tr>
<tr class="separator:ad8d40e63f28b99fcffdbb2e237864482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9d1ead2ffc5ab1ec9aa6e06948c98ac" id="r_ad9d1ead2ffc5ab1ec9aa6e06948c98ac"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9d1ead2ffc5ab1ec9aa6e06948c98ac">GetMaxConcurrency</a> () const override</td></tr>
<tr class="memdesc:ad9d1ead2ffc5ab1ec9aa6e06948c98ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get maximum number of concurrently executing jobs.  <br /></td></tr>
<tr class="separator:ad9d1ead2ffc5ab1ec9aa6e06948c98ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa345080efb7aec00011c102b37988fa3" id="r_aa345080efb7aec00011c102b37988fa3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa345080efb7aec00011c102b37988fa3">CreateJob</a> (const char *inName, <a class="el" href="_color_8h.html#a3daf1ee578b30da1860ff132c70474b5">ColorArg</a> inColor, const <a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> &amp;inJobFunction, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumDependencies=0) override</td></tr>
<tr class="separator:aa345080efb7aec00011c102b37988fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b7f3271d9bd98562563d4dfcaa40c9d" id="r_a4b7f3271d9bd98562563d4dfcaa40c9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b7f3271d9bd98562563d4dfcaa40c9d">SetNumThreads</a> (int inNumThreads)</td></tr>
<tr class="memdesc:a4b7f3271d9bd98562563d4dfcaa40c9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the max concurrency after initialization.  <br /></td></tr>
<tr class="separator:a4b7f3271d9bd98562563d4dfcaa40c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_job_system_with_barrier"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_job_system_with_barrier')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_job_system_with_barrier.html">JobSystemWithBarrier</a></td></tr>
<tr class="memitem:a8bb3d115433cfb6bb59eea3105e1c8e1 inherit pub_methods_class_job_system_with_barrier" id="r_a8bb3d115433cfb6bb59eea3105e1c8e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#a8bb3d115433cfb6bb59eea3105e1c8e1">JobSystemWithBarrier</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers)</td></tr>
<tr class="separator:a8bb3d115433cfb6bb59eea3105e1c8e1 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf97f3f021e97a501e5383f55c3625e6 inherit pub_methods_class_job_system_with_barrier" id="r_aaf97f3f021e97a501e5383f55c3625e6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#aaf97f3f021e97a501e5383f55c3625e6">JobSystemWithBarrier</a> ()=default</td></tr>
<tr class="separator:aaf97f3f021e97a501e5383f55c3625e6 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3ef17ce10d2556e776375bef948b75 inherit pub_methods_class_job_system_with_barrier" id="r_a7d3ef17ce10d2556e776375bef948b75"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#a7d3ef17ce10d2556e776375bef948b75">~JobSystemWithBarrier</a> () override</td></tr>
<tr class="separator:a7d3ef17ce10d2556e776375bef948b75 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c53b2eecf2984531affd3867815214 inherit pub_methods_class_job_system_with_barrier" id="r_a07c53b2eecf2984531affd3867815214"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#a07c53b2eecf2984531affd3867815214">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers)</td></tr>
<tr class="separator:a07c53b2eecf2984531affd3867815214 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19401113c3246594dd83bc4563823ec5 inherit pub_methods_class_job_system_with_barrier" id="r_a19401113c3246594dd83bc4563823ec5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#a19401113c3246594dd83bc4563823ec5">CreateBarrier</a> () override</td></tr>
<tr class="memdesc:a19401113c3246594dd83bc4563823ec5 inherit pub_methods_class_job_system_with_barrier"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new barrier, used to wait on jobs.  <br /></td></tr>
<tr class="separator:a19401113c3246594dd83bc4563823ec5 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4827161974dbd03dff9c84424d75107e inherit pub_methods_class_job_system_with_barrier" id="r_a4827161974dbd03dff9c84424d75107e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#a4827161974dbd03dff9c84424d75107e">DestroyBarrier</a> (<a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *inBarrier) override</td></tr>
<tr class="memdesc:a4827161974dbd03dff9c84424d75107e inherit pub_methods_class_job_system_with_barrier"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a barrier when it is no longer used. The barrier should be empty at this point.  <br /></td></tr>
<tr class="separator:a4827161974dbd03dff9c84424d75107e inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af33b27708e9ab2b343a0658cf14efe56 inherit pub_methods_class_job_system_with_barrier" id="r_af33b27708e9ab2b343a0658cf14efe56"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_with_barrier.html#af33b27708e9ab2b343a0658cf14efe56">WaitForJobs</a> (<a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *inBarrier) override</td></tr>
<tr class="memdesc:af33b27708e9ab2b343a0658cf14efe56 inherit pub_methods_class_job_system_with_barrier"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for a set of jobs to be finished, note that only 1 thread can be waiting on a barrier at a time.  <br /></td></tr>
<tr class="separator:af33b27708e9ab2b343a0658cf14efe56 inherit pub_methods_class_job_system_with_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_job_system')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
<tr class="memitem:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system" id="r_aaaf28c0a93f2d52eb2c936807f9e8ec9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system.html#aaaf28c0a93f2d52eb2c936807f9e8ec9">~JobSystem</a> ()=default</td></tr>
<tr class="memdesc:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
<tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
<tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab915a93f53fed71c48afb2fdf0d40910" id="r_ab915a93f53fed71c48afb2fdf0d40910"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab915a93f53fed71c48afb2fdf0d40910">QueueJob</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob) override</td></tr>
<tr class="memdesc:ab915a93f53fed71c48afb2fdf0d40910"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a job to the job queue.  <br /></td></tr>
<tr class="separator:ab915a93f53fed71c48afb2fdf0d40910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60fe80b85a7711b87c51983d5fb5eb4a" id="r_a60fe80b85a7711b87c51983d5fb5eb4a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a60fe80b85a7711b87c51983d5fb5eb4a">QueueJobs</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> **inJobs, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumJobs) override</td></tr>
<tr class="memdesc:a60fe80b85a7711b87c51983d5fb5eb4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a number of jobs at once to the job queue.  <br /></td></tr>
<tr class="separator:a60fe80b85a7711b87c51983d5fb5eb4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af916eac26591613c671484a3b60ab047" id="r_af916eac26591613c671484a3b60ab047"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af916eac26591613c671484a3b60ab047">FreeJob</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob) override</td></tr>
<tr class="memdesc:af916eac26591613c671484a3b60ab047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a job.  <br /></td></tr>
<tr class="separator:af916eac26591613c671484a3b60ab047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_job_system')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of a <a class="el" href="class_job_system.html">JobSystem</a> using a thread pool</p>
<p>Note that this is considered an example implementation. It is expected that when you integrate the physics engine into your own project that you'll provide your own implementation of the <a class="el" href="class_job_system.html">JobSystem</a> built on top of whatever job system your project uses. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a380fb336206bb8188b5a68979ac432ab" name="a380fb336206bb8188b5a68979ac432ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a380fb336206bb8188b5a68979ac432ab">&#9670;&#160;</a></span>InitExitFunction</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a380fb336206bb8188b5a68979ac432ab">JobSystemThreadPool::InitExitFunction</a> = function&lt;void(int)&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Functions to call when a thread is initialized or exits, must be set before calling <a class="el" href="#ad8d40e63f28b99fcffdbb2e237864482">Init()</a> </p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adaccd4fc1faa23f3883c2d16e32d0382" name="adaccd4fc1faa23f3883c2d16e32d0382"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaccd4fc1faa23f3883c2d16e32d0382">&#9670;&#160;</a></span>JobSystemThreadPool() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JobSystemThreadPool::JobSystemThreadPool </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inMaxJobs</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inMaxBarriers</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inNumThreads</em></span><span class="paramdefsep"> = </span><span class="paramdefval">-1</span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Creates a thread pool. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="#ad8d40e63f28b99fcffdbb2e237864482">JobSystemThreadPool::Init</a> </dd></dl>

</div>
</div>
<a id="acf4a8888977261556ec87fea4ceb64aa" name="acf4a8888977261556ec87fea4ceb64aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf4a8888977261556ec87fea4ceb64aa">&#9670;&#160;</a></span>JobSystemThreadPool() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JobSystemThreadPool::JobSystemThreadPool </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a56f9475443e5598d7176d9b94da6bdff" name="a56f9475443e5598d7176d9b94da6bdff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56f9475443e5598d7176d9b94da6bdff">&#9670;&#160;</a></span>~JobSystemThreadPool()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JobSystemThreadPool::~JobSystemThreadPool </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</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="aa345080efb7aec00011c102b37988fa3" name="aa345080efb7aec00011c102b37988fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa345080efb7aec00011c102b37988fa3">&#9670;&#160;</a></span>CreateJob()</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="class_job_system_1_1_job_handle.html">JobHandle</a> JobSystemThreadPool::CreateJob </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_color_8h.html#a3daf1ee578b30da1860ff132c70474b5">ColorArg</a></td>          <td class="paramname"><span class="paramname"><em>inColor</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inJobFunction</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inNumDependencies</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create a new job, the job is started immediately if inNumDependencies == 0 otherwise it starts when RemoveDependency causes the dependency counter to reach 0. </p>

<p>Implements <a class="el" href="class_job_system.html#a0766c8acd5ed9ef0e6baf1c2b8f3c38b">JobSystem</a>.</p>

</div>
</div>
<a id="af916eac26591613c671484a3b60ab047" name="af916eac26591613c671484a3b60ab047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af916eac26591613c671484a3b60ab047">&#9670;&#160;</a></span>FreeJob()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::FreeJob </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> *</td>          <td class="paramname"><span class="paramname"><em>inJob</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Frees a job. </p>

<p>Implements <a class="el" href="class_job_system.html#aa74329d956a01e3f2f219ea22bdc5097">JobSystem</a>.</p>

</div>
</div>
<a id="ad9d1ead2ffc5ab1ec9aa6e06948c98ac" name="ad9d1ead2ffc5ab1ec9aa6e06948c98ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9d1ead2ffc5ab1ec9aa6e06948c98ac">&#9670;&#160;</a></span>GetMaxConcurrency()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int JobSystemThreadPool::GetMaxConcurrency </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get maximum number of concurrently executing jobs. </p>

<p>Implements <a class="el" href="class_job_system.html#a5953ad34be5c47e7896b87ac7409b7d7">JobSystem</a>.</p>

</div>
</div>
<a id="ad8d40e63f28b99fcffdbb2e237864482" name="ad8d40e63f28b99fcffdbb2e237864482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8d40e63f28b99fcffdbb2e237864482">&#9670;&#160;</a></span>Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> void JobSystemThreadPool::Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inMaxJobs</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inMaxBarriers</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inNumThreads</em></span><span class="paramdefsep"> = </span><span class="paramdefval">-1</span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the thread pool </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inMaxJobs</td><td>Max number of jobs that can be allocated at any time </td></tr>
    <tr><td class="paramname">inMaxBarriers</td><td>Max number of barriers that can be allocated at any time </td></tr>
    <tr><td class="paramname">inNumThreads</td><td>Number of threads to start (the number of concurrent jobs is 1 more because the main thread will also run jobs while waiting for a barrier to complete). Use -1 to auto detect the amount of CPU's. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ab915a93f53fed71c48afb2fdf0d40910" name="ab915a93f53fed71c48afb2fdf0d40910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab915a93f53fed71c48afb2fdf0d40910">&#9670;&#160;</a></span>QueueJob()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::QueueJob </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> *</td>          <td class="paramname"><span class="paramname"><em>inJob</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds a job to the job queue. </p>

<p>Implements <a class="el" href="class_job_system.html#ae6bae9c5725c2009c8e9a2d79f60cb40">JobSystem</a>.</p>

</div>
</div>
<a id="a60fe80b85a7711b87c51983d5fb5eb4a" name="a60fe80b85a7711b87c51983d5fb5eb4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60fe80b85a7711b87c51983d5fb5eb4a">&#9670;&#160;</a></span>QueueJobs()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::QueueJobs </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> **</td>          <td class="paramname"><span class="paramname"><em>inJobs</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inNumJobs</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds a number of jobs at once to the job queue. </p>

<p>Implements <a class="el" href="class_job_system.html#a5820eef46d040e6ae17e51a828201118">JobSystem</a>.</p>

</div>
</div>
<a id="a4b7f3271d9bd98562563d4dfcaa40c9d" name="a4b7f3271d9bd98562563d4dfcaa40c9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b7f3271d9bd98562563d4dfcaa40c9d">&#9670;&#160;</a></span>SetNumThreads()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::SetNumThreads </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inNumThreads</em></span></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>Change the max concurrency after initialization. </p>

</div>
</div>
<a id="a2b29fcac624eeac4e5219158ef0c4912" name="a2b29fcac624eeac4e5219158ef0c4912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b29fcac624eeac4e5219158ef0c4912">&#9670;&#160;</a></span>SetThreadExitFunction()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::SetThreadExitFunction </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inExitFunction</em></span></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="a7c1157b283998781be0e2164e5639ba3" name="a7c1157b283998781be0e2164e5639ba3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c1157b283998781be0e2164e5639ba3">&#9670;&#160;</a></span>SetThreadInitFunction()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystemThreadPool::SetThreadInitFunction </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inInitFunction</em></span></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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Core/<a class="el" href="_job_system_thread_pool_8h_source.html">JobSystemThreadPool.h</a></li>
<li>Jolt/Core/<a class="el" href="_job_system_thread_pool_8cpp.html">JobSystemThreadPool.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_job_system_thread_pool.html">JobSystemThreadPool</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  </ul>
</div>
</body>
</html>