_job_system_thread_pool_8h_source.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  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: Jolt/Core/JobSystemThreadPool.h Source File</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('_job_system_thread_pool_8h_source.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="headertitle"><div class="title">JobSystemThreadPool.h</div></div>
  107. </div><!--header-->
  108. <div class="contents">
  109. <a href="_job_system_thread_pool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
  110. <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2021 Jorrit Rouwe</span></div>
  111. <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
  112. <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
  113. <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
  114. <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
  115. <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="code" href="_job_system_with_barrier_8h.html">Jolt/Core/JobSystemWithBarrier.h</a>&gt;</span></div>
  116. <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;<a class="code" href="_fixed_size_free_list_8h.html">Jolt/Core/FixedSizeFreeList.h</a>&gt;</span></div>
  117. <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;<a class="code" href="_semaphore_8h.html">Jolt/Core/Semaphore.h</a>&gt;</span></div>
  118. <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
  119. <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><a class="code hl_define" href="_core_8h.html#a4ac413403e9ca00d24a3e2f244cf5456">JPH_SUPPRESS_WARNINGS_STD_BEGIN</a></div>
  120. <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;thread&gt;</span></div>
  121. <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><a class="code hl_define" href="_core_8h.html#a5f6b64537a538d9204b253532b799467">JPH_SUPPRESS_WARNINGS_STD_END</a></div>
  122. <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
  123. <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
  124. <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
  125. <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// Things we&#39;re using from STL</span></div>
  126. <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">using </span>std::thread;</div>
  127. <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
  128. <div class="foldopen" id="foldopen00025" data-start="{" data-end="};">
  129. <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html"> 25</a></span><span class="keyword">class </span><a class="code hl_define" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="code hl_class" href="class_job_system_thread_pool.html">JobSystemThreadPool</a> final : <span class="keyword">public</span> <a class="code hl_class" href="class_job_system_with_barrier.html">JobSystemWithBarrier</a></div>
  130. <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>{</div>
  131. <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">public</span>:</div>
  132. <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_define" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div>
  133. <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
  134. <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="class_job_system_thread_pool.html">JobSystemThreadPool</a>(<a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs, <a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers, <span class="keywordtype">int</span> inNumThreads = -1);</div>
  135. <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#acf4a8888977261556ec87fea4ceb64aa"> 33</a></span> <a class="code hl_function" href="class_job_system_thread_pool.html#acf4a8888977261556ec87fea4ceb64aa">JobSystemThreadPool</a>() = <span class="keywordflow">default</span>;</div>
  136. <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_job_system_thread_pool.html">~JobSystemThreadPool</a>() <span class="keyword">override</span>;</div>
  137. <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
  138. <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#a380fb336206bb8188b5a68979ac432ab"> 37</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="class_job_system_thread_pool.html#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> = function&lt;void(<span class="keywordtype">int</span>)&gt;;</div>
  139. <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#a7c1157b283998781be0e2164e5639ba3"> 38</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_thread_pool.html#a7c1157b283998781be0e2164e5639ba3">SetThreadInitFunction</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="class_job_system_thread_pool.html#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;inInitFunction) { mThreadInitFunction = inInitFunction; }</div>
  140. <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#a2b29fcac624eeac4e5219158ef0c4912"> 39</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_thread_pool.html#a2b29fcac624eeac4e5219158ef0c4912">SetThreadExitFunction</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="class_job_system_thread_pool.html#a380fb336206bb8188b5a68979ac432ab">InitExitFunction</a> &amp;inExitFunction) { mThreadExitFunction = inExitFunction; }</div>
  141. <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
  142. <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_with_barrier.html#a07c53b2eecf2984531affd3867815214">Init</a>(<a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs, <a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxBarriers, <span class="keywordtype">int</span> inNumThreads = -1);</div>
  143. <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
  144. <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// See JobSystem</span></div>
  145. <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#ad9d1ead2ffc5ab1ec9aa6e06948c98ac"> 48</a></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_job_system_thread_pool.html#ad9d1ead2ffc5ab1ec9aa6e06948c98ac">GetMaxConcurrency</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> int(mThreads.size()) + 1; }</div>
  146. <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_job_system_1_1_job_handle.html">JobHandle</a> <a class="code hl_function" href="class_job_system.html#a0766c8acd5ed9ef0e6baf1c2b8f3c38b">CreateJob</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *inName, <a class="code hl_class" href="class_color.html">ColorArg</a> inColor, <span class="keyword">const</span> JobFunction &amp;inJobFunction, <a class="code hl_typedef" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumDependencies = 0) <span class="keyword">override</span>;</div>
  147. <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
  148. <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="class_job_system_thread_pool.html#a4b7f3271d9bd98562563d4dfcaa40c9d"> 52</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_thread_pool.html#a4b7f3271d9bd98562563d4dfcaa40c9d">SetNumThreads</a>(<span class="keywordtype">int</span> inNumThreads) { StopThreads(); StartThreads(inNumThreads); }</div>
  149. <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
  150. <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">protected</span>:</div>
  151. <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// See JobSystem</span></div>
  152. <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system.html#ae6bae9c5725c2009c8e9a2d79f60cb40">QueueJob</a>(Job *inJob) <span class="keyword">override</span>;</div>
  153. <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system.html#a5820eef46d040e6ae17e51a828201118">QueueJobs</a>(Job **inJobs, <a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumJobs) <span class="keyword">override</span>;</div>
  154. <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system.html#aa74329d956a01e3f2f219ea22bdc5097">FreeJob</a>(Job *inJob) <span class="keyword">override</span>;</div>
  155. <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
  156. <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="keyword">private</span>:</div>
  157. <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> StartThreads(<span class="keywordtype">int</span> inNumThreads);</div>
  158. <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">void</span> StopThreads();</div>
  159. <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
  160. <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">void</span> ThreadMain(<span class="keywordtype">int</span> inThreadIndex);</div>
  161. <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
  162. <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">inline</span> <a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> GetHead() <span class="keyword">const</span>;</div>
  163. <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
  164. <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> QueueJobInternal(Job *inJob);</div>
  165. <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
  166. <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> InitExitFunction mThreadInitFunction = [](int) { };</div>
  167. <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> InitExitFunction mThreadExitFunction = [](int) { };</div>
  168. <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
  169. <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">using </span>AvailableJobs = <a class="code hl_class" href="class_fixed_size_free_list.html">FixedSizeFreeList&lt;Job&gt;</a>;</div>
  170. <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> AvailableJobs mJobs;</div>
  171. <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
  172. <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="class_array.html">Array&lt;thread&gt;</a> mThreads;</div>
  173. <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
  174. <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// The job queue</span></div>
  175. <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_typedef" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> cQueueLength = 1024;</div>
  176. <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">static_assert</span>(<a class="code hl_function" href="_math_8h.html#a531058b1613a4e5123a68a704673e1a2">IsPowerOf2</a>(cQueueLength)); <span class="comment">// We do bit operations and require queue length to be a power of 2</span></div>
  177. <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> atomic&lt;Job *&gt; mQueue[cQueueLength];</div>
  178. <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
  179. <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// Head and tail of the queue, do this value modulo cQueueLength - 1 to get the element in the mQueue array</span></div>
  180. <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> atomic&lt;uint&gt; * mHeads = <span class="keyword">nullptr</span>; </div>
  181. <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">alignas</span>(<a class="code hl_define" href="_core_8h.html#a2eca4e00d11d8fdbbd04c4a23a244278">JPH_CACHE_LINE_SIZE</a>) atomic&lt;uint&gt; mTail = 0; </div>
  182. <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
  183. <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Semaphore used to signal worker threads that there is new work</span></div>
  184. <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_class" href="class_semaphore.html">Semaphore</a> mSemaphore;</div>
  185. <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
  186. <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> atomic&lt;bool&gt; mQuit = <span class="keyword">false</span>;</div>
  187. <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>};</div>
  188. </div>
  189. <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
  190. <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
  191. <div class="ttc" id="a_core_8h_html_a2712a9b0f778ab9d1aa5118b4e8e6bd8"><div class="ttname"><a href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a></div><div class="ttdeci">#define JPH_EXPORT</div><div class="ttdef"><b>Definition</b> Core.h:275</div></div>
  192. <div class="ttc" id="a_core_8h_html_a2eca4e00d11d8fdbbd04c4a23a244278"><div class="ttname"><a href="_core_8h.html#a2eca4e00d11d8fdbbd04c4a23a244278">JPH_CACHE_LINE_SIZE</a></div><div class="ttdeci">#define JPH_CACHE_LINE_SIZE</div><div class="ttdef"><b>Definition</b> Core.h:545</div></div>
  193. <div class="ttc" id="a_core_8h_html_a4ac413403e9ca00d24a3e2f244cf5456"><div class="ttname"><a href="_core_8h.html#a4ac413403e9ca00d24a3e2f244cf5456">JPH_SUPPRESS_WARNINGS_STD_BEGIN</a></div><div class="ttdeci">#define JPH_SUPPRESS_WARNINGS_STD_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:430</div></div>
  194. <div class="ttc" id="a_core_8h_html_a5f6b64537a538d9204b253532b799467"><div class="ttname"><a href="_core_8h.html#a5f6b64537a538d9204b253532b799467">JPH_SUPPRESS_WARNINGS_STD_END</a></div><div class="ttdeci">#define JPH_SUPPRESS_WARNINGS_STD_END</div><div class="ttdef"><b>Definition</b> Core.h:443</div></div>
  195. <div class="ttc" id="a_core_8h_html_a69aa29b598b851b0640aa225a9e5d61d"><div class="ttname"><a href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></div><div class="ttdeci">unsigned int uint</div><div class="ttdef"><b>Definition</b> Core.h:500</div></div>
  196. <div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
  197. <div class="ttc" id="a_core_8h_html_a8f95e75e58492e87412191fabadd8ca8"><div class="ttname"><a href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></div><div class="ttdeci">std::uint32_t uint32</div><div class="ttdef"><b>Definition</b> Core.h:503</div></div>
  198. <div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
  199. <div class="ttc" id="a_fixed_size_free_list_8h_html"><div class="ttname"><a href="_fixed_size_free_list_8h.html">FixedSizeFreeList.h</a></div></div>
  200. <div class="ttc" id="a_job_system_with_barrier_8h_html"><div class="ttname"><a href="_job_system_with_barrier_8h.html">JobSystemWithBarrier.h</a></div></div>
  201. <div class="ttc" id="a_math_8h_html_a531058b1613a4e5123a68a704673e1a2"><div class="ttname"><a href="_math_8h.html#a531058b1613a4e5123a68a704673e1a2">IsPowerOf2</a></div><div class="ttdeci">constexpr bool IsPowerOf2(T inV)</div><div class="ttdoc">Check if inV is a power of 2.</div><div class="ttdef"><b>Definition</b> Math.h:76</div></div>
  202. <div class="ttc" id="a_memory_8h_html_a91074fb218fe28954a0938c099ddd9e0"><div class="ttname"><a href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div><div class="ttdeci">#define JPH_OVERRIDE_NEW_DELETE</div><div class="ttdoc">Macro to override the new and delete functions.</div><div class="ttdef"><b>Definition</b> Memory.h:50</div></div>
  203. <div class="ttc" id="a_semaphore_8h_html"><div class="ttname"><a href="_semaphore_8h.html">Semaphore.h</a></div></div>
  204. <div class="ttc" id="aclass_array_html"><div class="ttname"><a href="class_array.html">Array</a></div><div class="ttdef"><b>Definition</b> Array.h:36</div></div>
  205. <div class="ttc" id="aclass_color_html"><div class="ttname"><a href="class_color.html">Color</a></div><div class="ttdoc">Class that holds an RGBA color with 8-bits per component.</div><div class="ttdef"><b>Definition</b> Color.h:16</div></div>
  206. <div class="ttc" id="aclass_fixed_size_free_list_html"><div class="ttname"><a href="class_fixed_size_free_list.html">FixedSizeFreeList</a></div><div class="ttdef"><b>Definition</b> FixedSizeFreeList.h:18</div></div>
  207. <div class="ttc" id="aclass_job_system_1_1_job_handle_html"><div class="ttname"><a href="class_job_system_1_1_job_handle.html">JobSystem::JobHandle</a></div><div class="ttdef"><b>Definition</b> JobSystem.h:80</div></div>
  208. <div class="ttc" id="aclass_job_system_html_a0766c8acd5ed9ef0e6baf1c2b8f3c38b"><div class="ttname"><a href="class_job_system.html#a0766c8acd5ed9ef0e6baf1c2b8f3c38b">JobSystem::CreateJob</a></div><div class="ttdeci">virtual JobHandle CreateJob(const char *inName, ColorArg inColor, const JobFunction &amp;inJobFunction, uint32 inNumDependencies=0)=0</div></div>
  209. <div class="ttc" id="aclass_job_system_html_a5820eef46d040e6ae17e51a828201118"><div class="ttname"><a href="class_job_system.html#a5820eef46d040e6ae17e51a828201118">JobSystem::QueueJobs</a></div><div class="ttdeci">virtual void QueueJobs(Job **inJobs, uint inNumJobs)=0</div><div class="ttdoc">Adds a number of jobs at once to the job queue.</div></div>
  210. <div class="ttc" id="aclass_job_system_html_aa74329d956a01e3f2f219ea22bdc5097"><div class="ttname"><a href="class_job_system.html#aa74329d956a01e3f2f219ea22bdc5097">JobSystem::FreeJob</a></div><div class="ttdeci">virtual void FreeJob(Job *inJob)=0</div><div class="ttdoc">Frees a job.</div></div>
  211. <div class="ttc" id="aclass_job_system_html_ae6bae9c5725c2009c8e9a2d79f60cb40"><div class="ttname"><a href="class_job_system.html#ae6bae9c5725c2009c8e9a2d79f60cb40">JobSystem::QueueJob</a></div><div class="ttdeci">virtual void QueueJob(Job *inJob)=0</div><div class="ttdoc">Adds a job to the job queue.</div></div>
  212. <div class="ttc" id="aclass_job_system_thread_pool_html"><div class="ttname"><a href="class_job_system_thread_pool.html">JobSystemThreadPool</a></div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:26</div></div>
  213. <div class="ttc" id="aclass_job_system_thread_pool_html_a2b29fcac624eeac4e5219158ef0c4912"><div class="ttname"><a href="class_job_system_thread_pool.html#a2b29fcac624eeac4e5219158ef0c4912">JobSystemThreadPool::SetThreadExitFunction</a></div><div class="ttdeci">void SetThreadExitFunction(const InitExitFunction &amp;inExitFunction)</div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:39</div></div>
  214. <div class="ttc" id="aclass_job_system_thread_pool_html_a380fb336206bb8188b5a68979ac432ab"><div class="ttname"><a href="class_job_system_thread_pool.html#a380fb336206bb8188b5a68979ac432ab">JobSystemThreadPool::InitExitFunction</a></div><div class="ttdeci">function&lt; void(int)&gt; InitExitFunction</div><div class="ttdoc">Functions to call when a thread is initialized or exits, must be set before calling Init()</div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:37</div></div>
  215. <div class="ttc" id="aclass_job_system_thread_pool_html_a4b7f3271d9bd98562563d4dfcaa40c9d"><div class="ttname"><a href="class_job_system_thread_pool.html#a4b7f3271d9bd98562563d4dfcaa40c9d">JobSystemThreadPool::SetNumThreads</a></div><div class="ttdeci">void SetNumThreads(int inNumThreads)</div><div class="ttdoc">Change the max concurrency after initialization.</div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:52</div></div>
  216. <div class="ttc" id="aclass_job_system_thread_pool_html_a7c1157b283998781be0e2164e5639ba3"><div class="ttname"><a href="class_job_system_thread_pool.html#a7c1157b283998781be0e2164e5639ba3">JobSystemThreadPool::SetThreadInitFunction</a></div><div class="ttdeci">void SetThreadInitFunction(const InitExitFunction &amp;inInitFunction)</div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:38</div></div>
  217. <div class="ttc" id="aclass_job_system_thread_pool_html_acf4a8888977261556ec87fea4ceb64aa"><div class="ttname"><a href="class_job_system_thread_pool.html#acf4a8888977261556ec87fea4ceb64aa">JobSystemThreadPool::JobSystemThreadPool</a></div><div class="ttdeci">JobSystemThreadPool()=default</div></div>
  218. <div class="ttc" id="aclass_job_system_thread_pool_html_ad9d1ead2ffc5ab1ec9aa6e06948c98ac"><div class="ttname"><a href="class_job_system_thread_pool.html#ad9d1ead2ffc5ab1ec9aa6e06948c98ac">JobSystemThreadPool::GetMaxConcurrency</a></div><div class="ttdeci">virtual int GetMaxConcurrency() const override</div><div class="ttdoc">Get maximum number of concurrently executing jobs.</div><div class="ttdef"><b>Definition</b> JobSystemThreadPool.h:48</div></div>
  219. <div class="ttc" id="aclass_job_system_with_barrier_html"><div class="ttname"><a href="class_job_system_with_barrier.html">JobSystemWithBarrier</a></div><div class="ttdef"><b>Definition</b> JobSystemWithBarrier.h:24</div></div>
  220. <div class="ttc" id="aclass_job_system_with_barrier_html_a07c53b2eecf2984531affd3867815214"><div class="ttname"><a href="class_job_system_with_barrier.html#a07c53b2eecf2984531affd3867815214">JobSystemWithBarrier::Init</a></div><div class="ttdeci">void Init(uint inMaxBarriers)</div><div class="ttdef"><b>Definition</b> JobSystemWithBarrier.cpp:170</div></div>
  221. <div class="ttc" id="aclass_semaphore_html"><div class="ttname"><a href="class_semaphore.html">Semaphore</a></div><div class="ttdef"><b>Definition</b> Semaphore.h:32</div></div>
  222. </div><!-- fragment --></div><!-- contents -->
  223. </div><!-- doc-content -->
  224. <!-- start footer part -->
  225. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  226. <ul>
  227. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_1b21a6f5692b6d84bf3b848a79181d46.html">Core</a></li><li class="navelem"><a class="el" href="_job_system_thread_pool_8h.html">JobSystemThreadPool.h</a></li>
  228. <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>
  229. </ul>
  230. </div>
  231. </body>
  232. </html>