class_job_system_single_threaded.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: JobSystemSingleThreaded Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_job_system_single_threaded.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#nested-classes">Classes</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pro-types">Protected Types</a> &#124;
  110. <a href="#pro-methods">Protected Member Functions</a> &#124;
  111. <a href="#pro-attribs">Protected Attributes</a> &#124;
  112. <a href="class_job_system_single_threaded-members.html">List of all members</a> </div>
  113. <div class="headertitle"><div class="title">JobSystemSingleThreaded Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
  114. </div><!--header-->
  115. <div class="contents">
  116. <p>Implementation of a <a class="el" href="class_job_system.html">JobSystem</a> without threads, runs jobs as soon as they are added.
  117. <a href="#details">More...</a></p>
  118. <p><code>#include &lt;<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a>&gt;</code></p>
  119. <div class="dynheader">
  120. Inheritance diagram for JobSystemSingleThreaded:</div>
  121. <div class="dyncontent">
  122. <div class="center">
  123. <img src="class_job_system_single_threaded.png" usemap="#JobSystemSingleThreaded_map" alt=""/>
  124. <map id="JobSystemSingleThreaded_map" name="JobSystemSingleThreaded_map">
  125. <area href="class_job_system.html" alt="JobSystem" shape="rect" coords="0,56,162,80"/>
  126. <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,162,24"/>
  127. </map>
  128. </div></div>
  129. <table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  131. Classes</h2></td></tr>
  132. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a></td></tr>
  133. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  136. Public Member Functions</h2></td></tr>
  137. <tr class="memitem:ac04954b37964301fdc8c569fff04a6eb" id="r_ac04954b37964301fdc8c569fff04a6eb"><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="#ac04954b37964301fdc8c569fff04a6eb">JobSystemSingleThreaded</a> ()=default</td></tr>
  138. <tr class="memdesc:ac04954b37964301fdc8c569fff04a6eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  139. <tr class="separator:ac04954b37964301fdc8c569fff04a6eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a9c9d96208c3ff6d3fc601da994b56198" id="r_a9c9d96208c3ff6d3fc601da994b56198"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c9d96208c3ff6d3fc601da994b56198">JobSystemSingleThreaded</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs)</td></tr>
  141. <tr class="separator:a9c9d96208c3ff6d3fc601da994b56198"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a9a7a97646eaa417b4860df72739a64d9" id="r_a9a7a97646eaa417b4860df72739a64d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a7a97646eaa417b4860df72739a64d9">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs)</td></tr>
  143. <tr class="separator:a9a7a97646eaa417b4860df72739a64d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a4e99aebfb2308cf3c4bdd8e54bb71799" id="r_a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e99aebfb2308cf3c4bdd8e54bb71799">GetMaxConcurrency</a> () const override</td></tr>
  145. <tr class="memdesc:a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get maximum number of concurrently executing jobs. <br /></td></tr>
  146. <tr class="separator:a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ac183b901c9be0f04f21ff493cb5b2ec7" id="r_ac183b901c9be0f04f21ff493cb5b2ec7"><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="#ac183b901c9be0f04f21ff493cb5b2ec7">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>
  148. <tr class="separator:ac183b901c9be0f04f21ff493cb5b2ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ade901f3e457e5f60b071388bc6557778" id="r_ade901f3e457e5f60b071388bc6557778"><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="#ade901f3e457e5f60b071388bc6557778">CreateBarrier</a> () override</td></tr>
  150. <tr class="memdesc:ade901f3e457e5f60b071388bc6557778"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new barrier, used to wait on jobs. <br /></td></tr>
  151. <tr class="separator:ade901f3e457e5f60b071388bc6557778"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a9333b0d4cb69ade4b4045b518c77a120" id="r_a9333b0d4cb69ade4b4045b518c77a120"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9333b0d4cb69ade4b4045b518c77a120">DestroyBarrier</a> (<a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *inBarrier) override</td></tr>
  153. <tr class="memdesc:a9333b0d4cb69ade4b4045b518c77a120"><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>
  154. <tr class="separator:a9333b0d4cb69ade4b4045b518c77a120"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:aa491ca6999f7f2285a79b114b696e6ac" id="r_aa491ca6999f7f2285a79b114b696e6ac"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa491ca6999f7f2285a79b114b696e6ac">WaitForJobs</a> (<a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *inBarrier) override</td></tr>
  156. <tr class="memdesc:aa491ca6999f7f2285a79b114b696e6ac"><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>
  157. <tr class="separator:aa491ca6999f7f2285a79b114b696e6ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <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>
  160. <tr class="memdesc:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  161. <tr class="separator:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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>
  163. <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>
  164. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <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>
  166. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. </table><table class="memberdecls">
  170. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
  171. Protected Types</h2></td></tr>
  172. <tr class="memitem:ae327b71ac563cfe1d2c5623511291450" id="r_ae327b71ac563cfe1d2c5623511291450"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae327b71ac563cfe1d2c5623511291450">AvailableJobs</a> = <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt;<a class="el" href="class_job_system_1_1_job.html">Job</a>&gt;</td></tr>
  173. <tr class="memdesc:ae327b71ac563cfe1d2c5623511291450"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_array.html">Array</a> of jobs (fixed size) <br /></td></tr>
  174. <tr class="separator:ae327b71ac563cfe1d2c5623511291450"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. </table><table class="memberdecls">
  176. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  177. Protected Member Functions</h2></td></tr>
  178. <tr class="memitem:ac3eead674dbe8a93398dcbc13b324da5" id="r_ac3eead674dbe8a93398dcbc13b324da5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac3eead674dbe8a93398dcbc13b324da5">QueueJob</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob) override</td></tr>
  179. <tr class="memdesc:ac3eead674dbe8a93398dcbc13b324da5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a job to the job queue. <br /></td></tr>
  180. <tr class="separator:ac3eead674dbe8a93398dcbc13b324da5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a1581f359dde3922b6b3f973ec78c73df" id="r_a1581f359dde3922b6b3f973ec78c73df"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1581f359dde3922b6b3f973ec78c73df">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>
  182. <tr class="memdesc:a1581f359dde3922b6b3f973ec78c73df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a number of jobs at once to the job queue. <br /></td></tr>
  183. <tr class="separator:a1581f359dde3922b6b3f973ec78c73df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:abb23fc08db8c653059c7ab32e44fd7fd" id="r_abb23fc08db8c653059c7ab32e44fd7fd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb23fc08db8c653059c7ab32e44fd7fd">FreeJob</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob) override</td></tr>
  185. <tr class="memdesc:abb23fc08db8c653059c7ab32e44fd7fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a job. <br /></td></tr>
  186. <tr class="separator:abb23fc08db8c653059c7ab32e44fd7fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <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>
  188. </table><table class="memberdecls">
  189. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  190. Protected Attributes</h2></td></tr>
  191. <tr class="memitem:a0ef030c1327f4ebf4eb7c5ef383003d1" id="r_a0ef030c1327f4ebf4eb7c5ef383003d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ef030c1327f4ebf4eb7c5ef383003d1">mDummyBarrier</a></td></tr>
  192. <tr class="memdesc:a0ef030c1327f4ebf4eb7c5ef383003d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared barrier since the barrier implementation does nothing. <br /></td></tr>
  193. <tr class="separator:a0ef030c1327f4ebf4eb7c5ef383003d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:a46ee269e0b3c8933cade0f12dbd47d88" id="r_a46ee269e0b3c8933cade0f12dbd47d88"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ae327b71ac563cfe1d2c5623511291450">AvailableJobs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46ee269e0b3c8933cade0f12dbd47d88">mJobs</a></td></tr>
  195. <tr class="separator:a46ee269e0b3c8933cade0f12dbd47d88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. </table><table class="memberdecls">
  197. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  198. Additional Inherited Members</h2></td></tr>
  199. <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>
  200. <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>
  201. <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>
  202. <tr class="separator:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. </table>
  204. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  205. <div class="textblock"><p>Implementation of a <a class="el" href="class_job_system.html">JobSystem</a> without threads, runs jobs as soon as they are added. </p>
  206. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  207. <a id="ae327b71ac563cfe1d2c5623511291450" name="ae327b71ac563cfe1d2c5623511291450"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#ae327b71ac563cfe1d2c5623511291450">&#9670;&#160;</a></span>AvailableJobs</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="mlabels">
  212. <tr>
  213. <td class="mlabels-left">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">using <a class="el" href="#ae327b71ac563cfe1d2c5623511291450">JobSystemSingleThreaded::AvailableJobs</a> = <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a>&lt;<a class="el" href="class_job_system_1_1_job.html">Job</a>&gt;</td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p><a class="el" href="class_array.html">Array</a> of jobs (fixed size) </p>
  226. </div>
  227. </div>
  228. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  229. <a id="ac04954b37964301fdc8c569fff04a6eb" name="ac04954b37964301fdc8c569fff04a6eb"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#ac04954b37964301fdc8c569fff04a6eb">&#9670;&#160;</a></span>JobSystemSingleThreaded() <span class="overload">[1/2]</span></h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="mlabels">
  234. <tr>
  235. <td class="mlabels-left">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> JobSystemSingleThreaded::JobSystemSingleThreaded </td>
  239. <td>(</td>
  240. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  241. <td></td>
  242. </tr>
  243. </table>
  244. </td>
  245. <td class="mlabels-right">
  246. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Constructor. </p>
  251. </div>
  252. </div>
  253. <a id="a9c9d96208c3ff6d3fc601da994b56198" name="a9c9d96208c3ff6d3fc601da994b56198"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a9c9d96208c3ff6d3fc601da994b56198">&#9670;&#160;</a></span>JobSystemSingleThreaded() <span class="overload">[2/2]</span></h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">JobSystemSingleThreaded::JobSystemSingleThreaded </td>
  263. <td>(</td>
  264. <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><td>)</td>
  265. <td></td>
  266. </tr>
  267. </table>
  268. </td>
  269. <td class="mlabels-right">
  270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. </div>
  275. </div>
  276. <h2 class="groupheader">Member Function Documentation</h2>
  277. <a id="ade901f3e457e5f60b071388bc6557778" name="ade901f3e457e5f60b071388bc6557778"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#ade901f3e457e5f60b071388bc6557778">&#9670;&#160;</a></span>CreateBarrier()</h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname"><a class="el" href="class_job_system_1_1_barrier.html">JobSystem::Barrier</a> * JobSystemSingleThreaded::CreateBarrier </td>
  287. <td>(</td>
  288. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  289. <td></td>
  290. </tr>
  291. </table>
  292. </td>
  293. <td class="mlabels-right">
  294. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. <p>Create a new barrier, used to wait on jobs. </p>
  299. <p>Implements <a class="el" href="class_job_system.html#a2bd7c3efdc8f934b728ee1787e0bd58e">JobSystem</a>.</p>
  300. </div>
  301. </div>
  302. <a id="ac183b901c9be0f04f21ff493cb5b2ec7" name="ac183b901c9be0f04f21ff493cb5b2ec7"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#ac183b901c9be0f04f21ff493cb5b2ec7">&#9670;&#160;</a></span>CreateJob()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> JobSystemSingleThreaded::CreateJob </td>
  312. <td>(</td>
  313. <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <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>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <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>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <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>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <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>
  338. <p>Implements <a class="el" href="class_job_system.html#a0766c8acd5ed9ef0e6baf1c2b8f3c38b">JobSystem</a>.</p>
  339. </div>
  340. </div>
  341. <a id="a9333b0d4cb69ade4b4045b518c77a120" name="a9333b0d4cb69ade4b4045b518c77a120"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a9333b0d4cb69ade4b4045b518c77a120">&#9670;&#160;</a></span>DestroyBarrier()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">void JobSystemSingleThreaded::DestroyBarrier </td>
  351. <td>(</td>
  352. <td class="paramtype"><a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *</td> <td class="paramname"><span class="paramname"><em>inBarrier</em></span></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Destroy a barrier when it is no longer used. The barrier should be empty at this point. </p>
  363. <p>Implements <a class="el" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373">JobSystem</a>.</p>
  364. </div>
  365. </div>
  366. <a id="abb23fc08db8c653059c7ab32e44fd7fd" name="abb23fc08db8c653059c7ab32e44fd7fd"></a>
  367. <h2 class="memtitle"><span class="permalink"><a href="#abb23fc08db8c653059c7ab32e44fd7fd">&#9670;&#160;</a></span>FreeJob()</h2>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="mlabels">
  371. <tr>
  372. <td class="mlabels-left">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">void JobSystemSingleThreaded::FreeJob </td>
  376. <td>(</td>
  377. <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>
  378. <td></td>
  379. </tr>
  380. </table>
  381. </td>
  382. <td class="mlabels-right">
  383. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <p>Frees a job. </p>
  388. <p>Implements <a class="el" href="class_job_system.html#aa74329d956a01e3f2f219ea22bdc5097">JobSystem</a>.</p>
  389. </div>
  390. </div>
  391. <a id="a4e99aebfb2308cf3c4bdd8e54bb71799" name="a4e99aebfb2308cf3c4bdd8e54bb71799"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#a4e99aebfb2308cf3c4bdd8e54bb71799">&#9670;&#160;</a></span>GetMaxConcurrency()</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">virtual int JobSystemSingleThreaded::GetMaxConcurrency </td>
  401. <td>(</td>
  402. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  403. <td> const</td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Get maximum number of concurrently executing jobs. </p>
  413. <p>Implements <a class="el" href="class_job_system.html#a5953ad34be5c47e7896b87ac7409b7d7">JobSystem</a>.</p>
  414. </div>
  415. </div>
  416. <a id="a9a7a97646eaa417b4860df72739a64d9" name="a9a7a97646eaa417b4860df72739a64d9"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#a9a7a97646eaa417b4860df72739a64d9">&#9670;&#160;</a></span>Init()</h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> void JobSystemSingleThreaded::Init </td>
  423. <td>(</td>
  424. <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><td>)</td>
  425. <td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Initialize the job system </p><dl class="params"><dt>Parameters</dt><dd>
  430. <table class="params">
  431. <tr><td class="paramname">inMaxJobs</td><td>Max number of jobs that can be allocated at any time </td></tr>
  432. </table>
  433. </dd>
  434. </dl>
  435. </div>
  436. </div>
  437. <a id="ac3eead674dbe8a93398dcbc13b324da5" name="ac3eead674dbe8a93398dcbc13b324da5"></a>
  438. <h2 class="memtitle"><span class="permalink"><a href="#ac3eead674dbe8a93398dcbc13b324da5">&#9670;&#160;</a></span>QueueJob()</h2>
  439. <div class="memitem">
  440. <div class="memproto">
  441. <table class="mlabels">
  442. <tr>
  443. <td class="mlabels-left">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname">void JobSystemSingleThreaded::QueueJob </td>
  447. <td>(</td>
  448. <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>
  449. <td></td>
  450. </tr>
  451. </table>
  452. </td>
  453. <td class="mlabels-right">
  454. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>Adds a job to the job queue. </p>
  459. <p>Implements <a class="el" href="class_job_system.html#ae6bae9c5725c2009c8e9a2d79f60cb40">JobSystem</a>.</p>
  460. </div>
  461. </div>
  462. <a id="a1581f359dde3922b6b3f973ec78c73df" name="a1581f359dde3922b6b3f973ec78c73df"></a>
  463. <h2 class="memtitle"><span class="permalink"><a href="#a1581f359dde3922b6b3f973ec78c73df">&#9670;&#160;</a></span>QueueJobs()</h2>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="mlabels">
  467. <tr>
  468. <td class="mlabels-left">
  469. <table class="memname">
  470. <tr>
  471. <td class="memname">void JobSystemSingleThreaded::QueueJobs </td>
  472. <td>(</td>
  473. <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>
  474. </tr>
  475. <tr>
  476. <td class="paramkey"></td>
  477. <td></td>
  478. <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>
  479. </tr>
  480. </table>
  481. </td>
  482. <td class="mlabels-right">
  483. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <p>Adds a number of jobs at once to the job queue. </p>
  488. <p>Implements <a class="el" href="class_job_system.html#a5820eef46d040e6ae17e51a828201118">JobSystem</a>.</p>
  489. </div>
  490. </div>
  491. <a id="aa491ca6999f7f2285a79b114b696e6ac" name="aa491ca6999f7f2285a79b114b696e6ac"></a>
  492. <h2 class="memtitle"><span class="permalink"><a href="#aa491ca6999f7f2285a79b114b696e6ac">&#9670;&#160;</a></span>WaitForJobs()</h2>
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="mlabels">
  496. <tr>
  497. <td class="mlabels-left">
  498. <table class="memname">
  499. <tr>
  500. <td class="memname">void JobSystemSingleThreaded::WaitForJobs </td>
  501. <td>(</td>
  502. <td class="paramtype"><a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *</td> <td class="paramname"><span class="paramname"><em>inBarrier</em></span></td><td>)</td>
  503. <td></td>
  504. </tr>
  505. </table>
  506. </td>
  507. <td class="mlabels-right">
  508. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  509. </tr>
  510. </table>
  511. </div><div class="memdoc">
  512. <p>Wait for a set of jobs to be finished, note that only 1 thread can be waiting on a barrier at a time. </p>
  513. <p>Implements <a class="el" href="class_job_system.html#a32e93cf0a95e8893978cf1ee92eb41d7">JobSystem</a>.</p>
  514. </div>
  515. </div>
  516. <h2 class="groupheader">Member Data Documentation</h2>
  517. <a id="a0ef030c1327f4ebf4eb7c5ef383003d1" name="a0ef030c1327f4ebf4eb7c5ef383003d1"></a>
  518. <h2 class="memtitle"><span class="permalink"><a href="#a0ef030c1327f4ebf4eb7c5ef383003d1">&#9670;&#160;</a></span>mDummyBarrier</h2>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="mlabels">
  522. <tr>
  523. <td class="mlabels-left">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a> JobSystemSingleThreaded::mDummyBarrier</td>
  527. </tr>
  528. </table>
  529. </td>
  530. <td class="mlabels-right">
  531. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Shared barrier since the barrier implementation does nothing. </p>
  536. </div>
  537. </div>
  538. <a id="a46ee269e0b3c8933cade0f12dbd47d88" name="a46ee269e0b3c8933cade0f12dbd47d88"></a>
  539. <h2 class="memtitle"><span class="permalink"><a href="#a46ee269e0b3c8933cade0f12dbd47d88">&#9670;&#160;</a></span>mJobs</h2>
  540. <div class="memitem">
  541. <div class="memproto">
  542. <table class="mlabels">
  543. <tr>
  544. <td class="mlabels-left">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname"><a class="el" href="#ae327b71ac563cfe1d2c5623511291450">AvailableJobs</a> JobSystemSingleThreaded::mJobs</td>
  548. </tr>
  549. </table>
  550. </td>
  551. <td class="mlabels-right">
  552. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  553. </tr>
  554. </table>
  555. </div><div class="memdoc">
  556. </div>
  557. </div>
  558. <hr/>The documentation for this class was generated from the following files:<ul>
  559. <li>Jolt/Core/<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a></li>
  560. <li>Jolt/Core/<a class="el" href="_job_system_single_threaded_8cpp.html">JobSystemSingleThreaded.cpp</a></li>
  561. </ul>
  562. </div><!-- contents -->
  563. </div><!-- doc-content -->
  564. <!-- start footer part -->
  565. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  566. <ul>
  567. <li class="navelem"><a class="el" href="class_job_system_single_threaded.html">JobSystemSingleThreaded</a></li>
  568. <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>
  569. </ul>
  570. </div>
  571. </body>
  572. </html>