class_job_system_single_threaded_1_1_barrier_impl.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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::BarrierImpl 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_1_1_barrier_impl.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="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="#pro-methods">Protected Member Functions</a> &#124;
  109. <a href="class_job_system_single_threaded_1_1_barrier_impl-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">JobSystemSingleThreaded::BarrierImpl Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a>&gt;</code></p>
  114. <div class="dynheader">
  115. Inheritance diagram for JobSystemSingleThreaded::BarrierImpl:</div>
  116. <div class="dyncontent">
  117. <div class="center">
  118. <img src="class_job_system_single_threaded_1_1_barrier_impl.png" usemap="#JobSystemSingleThreaded::BarrierImpl_map" alt=""/>
  119. <map id="JobSystemSingleThreaded::BarrierImpl_map" name="JobSystemSingleThreaded::BarrierImpl_map">
  120. <area href="class_job_system_1_1_barrier.html" title="A job barrier keeps track of a number of jobs and allows waiting until they are all completed." alt="JobSystem::Barrier" shape="rect" coords="0,56,230,80"/>
  121. <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,230,24"/>
  122. </map>
  123. </div></div>
  124. <table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  126. Public Member Functions</h2></td></tr>
  127. <tr class="memitem:a777f9190686403c3a8d0796c0fe56077" id="r_a777f9190686403c3a8d0796c0fe56077"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a777f9190686403c3a8d0796c0fe56077">AddJob</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;inJob) override</td></tr>
  128. <tr class="separator:a777f9190686403c3a8d0796c0fe56077"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a124bc867efebec305deb57931370dc28" id="r_a124bc867efebec305deb57931370dc28"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a124bc867efebec305deb57931370dc28">AddJobs</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> *inHandles, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumHandles) override</td></tr>
  130. <tr class="separator:a124bc867efebec305deb57931370dc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="inherit_header pub_methods_class_job_system_1_1_barrier"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_job_system_1_1_barrier')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_job_system_1_1_barrier.html">JobSystem::Barrier</a></td></tr>
  132. <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>
  133. <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>
  134. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table><table class="memberdecls">
  140. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  141. Protected Member Functions</h2></td></tr>
  142. <tr class="memitem:ad13990ca369c5cb94826dd026a447733" id="r_ad13990ca369c5cb94826dd026a447733"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad13990ca369c5cb94826dd026a447733">OnJobFinished</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob) override</td></tr>
  143. <tr class="memdesc:ad13990ca369c5cb94826dd026a447733"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by a Job to mark that it is finished. <br /></td></tr>
  144. <tr class="separator:ad13990ca369c5cb94826dd026a447733"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="inherit_header pro_methods_class_job_system_1_1_barrier"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_job_system_1_1_barrier')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_job_system_1_1_barrier.html">JobSystem::Barrier</a></td></tr>
  146. <tr class="memitem:aa7553c8c987ca8bb810c2715ef8ffbbd inherit pro_methods_class_job_system_1_1_barrier" id="r_aa7553c8c987ca8bb810c2715ef8ffbbd"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_1_1_barrier.html#aa7553c8c987ca8bb810c2715ef8ffbbd">~Barrier</a> ()=default</td></tr>
  147. <tr class="memdesc:aa7553c8c987ca8bb810c2715ef8ffbbd inherit pro_methods_class_job_system_1_1_barrier"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor, you should call <a class="el" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373" title="Destroy a barrier when it is no longer used. The barrier should be empty at this point.">JobSystem::DestroyBarrier</a> instead of destructing this object directly. <br /></td></tr>
  148. <tr class="separator:aa7553c8c987ca8bb810c2715ef8ffbbd inherit pro_methods_class_job_system_1_1_barrier"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table>
  150. <h2 class="groupheader">Member Function Documentation</h2>
  151. <a id="a777f9190686403c3a8d0796c0fe56077" name="a777f9190686403c3a8d0796c0fe56077"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a777f9190686403c3a8d0796c0fe56077">&#9670;&#160;</a></span>AddJob()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> void JobSystemSingleThreaded::BarrierImpl::AddJob </td>
  161. <td>(</td>
  162. <td class="paramtype">const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inJob</em></span></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </td>
  167. <td class="mlabels-right">
  168. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Add a job to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier </p>
  173. <p>Implements <a class="el" href="class_job_system_1_1_barrier.html#afcf8f345a7a19e1399c4899942ed49c4">JobSystem::Barrier</a>.</p>
  174. </div>
  175. </div>
  176. <a id="a124bc867efebec305deb57931370dc28" name="a124bc867efebec305deb57931370dc28"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#a124bc867efebec305deb57931370dc28">&#9670;&#160;</a></span>AddJobs()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">virtual void JobSystemSingleThreaded::BarrierImpl::AddJobs </td>
  186. <td>(</td>
  187. <td class="paramtype">const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> *</td> <td class="paramname"><span class="paramname"><em>inHandles</em></span>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumHandles</em></span>&#160;)</td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Add multiple jobs to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier </p>
  202. <p>Implements <a class="el" href="class_job_system_1_1_barrier.html#ad62875b2d5b89282bfaae824cac1a476">JobSystem::Barrier</a>.</p>
  203. </div>
  204. </div>
  205. <a id="ad13990ca369c5cb94826dd026a447733" name="ad13990ca369c5cb94826dd026a447733"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#ad13990ca369c5cb94826dd026a447733">&#9670;&#160;</a></span>OnJobFinished()</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="mlabels">
  210. <tr>
  211. <td class="mlabels-left">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">virtual void JobSystemSingleThreaded::BarrierImpl::OnJobFinished </td>
  215. <td>(</td>
  216. <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>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Called by a Job to mark that it is finished. </p>
  227. <p>Implements <a class="el" href="class_job_system_1_1_barrier.html#ab76635eef3bb293a2bceb429192adb2a">JobSystem::Barrier</a>.</p>
  228. </div>
  229. </div>
  230. <hr/>The documentation for this class was generated from the following file:<ul>
  231. <li>Jolt/Core/<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a></li>
  232. </ul>
  233. </div><!-- contents -->
  234. </div><!-- doc-content -->
  235. <!-- start footer part -->
  236. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  237. <ul>
  238. <li class="navelem"><a class="el" href="class_job_system_single_threaded.html">JobSystemSingleThreaded</a></li><li class="navelem"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a></li>
  239. <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>
  240. </ul>
  241. </div>
  242. </body>
  243. </html>