| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211 |
- <!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: Jolt/Core/JobSystemSingleThreaded.h Source File</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&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
- $(function(){initNavTree('_job_system_single_threaded_8h_source.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="headertitle"><div class="title">JobSystemSingleThreaded.h</div></div>
- </div><!--header-->
- <div class="contents">
- <a href="_job_system_single_threaded_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>
- <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2023 Jorrit Rouwe</span></div>
- <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
- <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
- <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
- <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
- <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <<a class="code" href="_job_system_8h.html">Jolt/Core/JobSystem.h</a>></span></div>
- <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <<a class="code" href="_fixed_size_free_list_8h.html">Jolt/Core/FixedSizeFreeList.h</a>></span></div>
- <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
- <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
- <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
- <div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
- <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html"> 13</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_single_threaded.html">JobSystemSingleThreaded</a> final : <span class="keyword">public</span> <a class="code hl_class" href="class_job_system.html">JobSystem</a></div>
- <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
- <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">public</span>:</div>
- <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <a class="code hl_define" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div>
- <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
- <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#ac04954b37964301fdc8c569fff04a6eb"> 19</a></span> <a class="code hl_function" href="class_job_system_single_threaded.html#ac04954b37964301fdc8c569fff04a6eb">JobSystemSingleThreaded</a>() = <span class="keywordflow">default</span>;</div>
- <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#a9c9d96208c3ff6d3fc601da994b56198"> 20</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="class_job_system_single_threaded.html#a9c9d96208c3ff6d3fc601da994b56198">JobSystemSingleThreaded</a>(<a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs) { Init(inMaxJobs); }</div>
- <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
- <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span> Init(<a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inMaxJobs);</div>
- <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
- <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// See JobSystem</span></div>
- <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#a4e99aebfb2308cf3c4bdd8e54bb71799"> 27</a></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_job_system_single_threaded.html#a4e99aebfb2308cf3c4bdd8e54bb71799">GetMaxConcurrency</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> 1; }</div>
- <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</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 &inJobFunction, <a class="code hl_typedef" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumDependencies = 0) <span class="keyword">override</span>;</div>
- <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">virtual</span> Barrier * <a class="code hl_function" href="class_job_system.html#a2bd7c3efdc8f934b728ee1787e0bd58e">CreateBarrier</a>() <span class="keyword">override</span>;</div>
- <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373">DestroyBarrier</a>(Barrier *inBarrier) <span class="keyword">override</span>;</div>
- <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system.html#a32e93cf0a95e8893978cf1ee92eb41d7">WaitForJobs</a>(Barrier *inBarrier) <span class="keyword">override</span>;</div>
- <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
- <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">protected</span>:</div>
- <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Dummy implementation of Barrier, all jobs are executed immediately</span></div>
- <div class="foldopen" id="foldopen00035" data-start="{" data-end="};">
- <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded_1_1_barrier_impl.html"> 35</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_job_system_1_1_barrier.html">Barrier</a></div>
- <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
- <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
- <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_define" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div>
- <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
- <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// See Barrier</span></div>
- <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded_1_1_barrier_impl.html#a777f9190686403c3a8d0796c0fe56077"> 41</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_single_threaded_1_1_barrier_impl.html#a777f9190686403c3a8d0796c0fe56077">AddJob</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_job_system_1_1_job_handle.html">JobHandle</a> &inJob)<span class="keyword"> override </span>{ <span class="comment">/* We don't need to track jobs */</span> }</div>
- <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded_1_1_barrier_impl.html#a124bc867efebec305deb57931370dc28"> 42</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_single_threaded_1_1_barrier_impl.html#a124bc867efebec305deb57931370dc28">AddJobs</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_job_system_1_1_job_handle.html">JobHandle</a> *inHandles, <a class="code hl_typedef" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumHandles)<span class="keyword"> override </span>{ <span class="comment">/* We don't need to track jobs */</span> }</div>
- <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
- <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">protected</span>:</div>
- <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded_1_1_barrier_impl.html#ad13990ca369c5cb94826dd026a447733"> 46</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_job_system_single_threaded_1_1_barrier_impl.html#ad13990ca369c5cb94826dd026a447733">OnJobFinished</a>(<a class="code hl_class" href="class_job_system_1_1_job.html">Job</a> *inJob)<span class="keyword"> override </span>{ <span class="comment">/* We don't need to track jobs */</span> }</div>
- <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> };</div>
- </div>
- <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
- <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// See JobSystem</span></div>
- <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</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>
- <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</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>
- <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</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>
- <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
- <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#a0ef030c1327f4ebf4eb7c5ef383003d1"> 55</a></span> <a class="code hl_class" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a> <a class="code hl_variable" href="class_job_system_single_threaded.html#a0ef030c1327f4ebf4eb7c5ef383003d1">mDummyBarrier</a>;</div>
- <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
- <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#ae327b71ac563cfe1d2c5623511291450"> 58</a></span> <span class="keyword">using </span><a class="code hl_class" href="class_fixed_size_free_list.html">AvailableJobs</a> = <a class="code hl_class" href="class_fixed_size_free_list.html">FixedSizeFreeList<Job></a>;</div>
- <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="class_job_system_single_threaded.html#a46ee269e0b3c8933cade0f12dbd47d88"> 59</a></span> <a class="code hl_class" href="class_fixed_size_free_list.html">AvailableJobs</a> <a class="code hl_variable" href="class_job_system_single_threaded.html#a46ee269e0b3c8933cade0f12dbd47d88">mJobs</a>;</div>
- <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
- </div>
- <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
- <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <div class="ttc" id="a_job_system_8h_html"><div class="ttname"><a href="_job_system_8h.html">JobSystem.h</a></div></div>
- <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>
- <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>
- <div class="ttc" id="aclass_fixed_size_free_list_html"><div class="ttname"><a href="class_fixed_size_free_list.html">FixedSizeFreeList< Job ></a></div></div>
- <div class="ttc" id="aclass_job_system_1_1_barrier_html"><div class="ttname"><a href="class_job_system_1_1_barrier.html">JobSystem::Barrier</a></div><div class="ttdoc">A job barrier keeps track of a number of jobs and allows waiting until they are all completed.</div><div class="ttdef"><b>Definition</b> JobSystem.h:123</div></div>
- <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>
- <div class="ttc" id="aclass_job_system_1_1_job_html"><div class="ttname"><a href="class_job_system_1_1_job.html">JobSystem::Job</a></div><div class="ttdoc">A class that contains information for a single unit of work.</div><div class="ttdef"><b>Definition</b> JobSystem.h:171</div></div>
- <div class="ttc" id="aclass_job_system_html"><div class="ttname"><a href="class_job_system.html">JobSystem</a></div><div class="ttdef"><b>Definition</b> JobSystem.h:70</div></div>
- <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 &inJobFunction, uint32 inNumDependencies=0)=0</div></div>
- <div class="ttc" id="aclass_job_system_html_a2bd7c3efdc8f934b728ee1787e0bd58e"><div class="ttname"><a href="class_job_system.html#a2bd7c3efdc8f934b728ee1787e0bd58e">JobSystem::CreateBarrier</a></div><div class="ttdeci">virtual Barrier * CreateBarrier()=0</div><div class="ttdoc">Create a new barrier, used to wait on jobs.</div></div>
- <div class="ttc" id="aclass_job_system_html_a32e93cf0a95e8893978cf1ee92eb41d7"><div class="ttname"><a href="class_job_system.html#a32e93cf0a95e8893978cf1ee92eb41d7">JobSystem::WaitForJobs</a></div><div class="ttdeci">virtual void WaitForJobs(Barrier *inBarrier)=0</div><div class="ttdoc">Wait for a set of jobs to be finished, note that only 1 thread can be waiting on a barrier at a time.</div></div>
- <div class="ttc" id="aclass_job_system_html_a51c615924cf4f8eefb8e3fbe72041373"><div class="ttname"><a href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373">JobSystem::DestroyBarrier</a></div><div class="ttdeci">virtual void DestroyBarrier(Barrier *inBarrier)=0</div><div class="ttdoc">Destroy a barrier when it is no longer used. The barrier should be empty at this point.</div></div>
- <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>
- <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>
- <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>
- <div class="ttc" id="aclass_job_system_single_threaded_1_1_barrier_impl_html"><div class="ttname"><a href="class_job_system_single_threaded_1_1_barrier_impl.html">JobSystemSingleThreaded::BarrierImpl</a></div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:36</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_1_1_barrier_impl_html_a124bc867efebec305deb57931370dc28"><div class="ttname"><a href="class_job_system_single_threaded_1_1_barrier_impl.html#a124bc867efebec305deb57931370dc28">JobSystemSingleThreaded::BarrierImpl::AddJobs</a></div><div class="ttdeci">virtual void AddJobs(const JobHandle *inHandles, uint inNumHandles) override</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:42</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_1_1_barrier_impl_html_a777f9190686403c3a8d0796c0fe56077"><div class="ttname"><a href="class_job_system_single_threaded_1_1_barrier_impl.html#a777f9190686403c3a8d0796c0fe56077">JobSystemSingleThreaded::BarrierImpl::AddJob</a></div><div class="ttdeci">virtual JPH_OVERRIDE_NEW_DELETE void AddJob(const JobHandle &inJob) override</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:41</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_1_1_barrier_impl_html_ad13990ca369c5cb94826dd026a447733"><div class="ttname"><a href="class_job_system_single_threaded_1_1_barrier_impl.html#ad13990ca369c5cb94826dd026a447733">JobSystemSingleThreaded::BarrierImpl::OnJobFinished</a></div><div class="ttdeci">virtual void OnJobFinished(Job *inJob) override</div><div class="ttdoc">Called by a Job to mark that it is finished.</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:46</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html"><div class="ttname"><a href="class_job_system_single_threaded.html">JobSystemSingleThreaded</a></div><div class="ttdoc">Implementation of a JobSystem without threads, runs jobs as soon as they are added.</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:14</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html_a0ef030c1327f4ebf4eb7c5ef383003d1"><div class="ttname"><a href="class_job_system_single_threaded.html#a0ef030c1327f4ebf4eb7c5ef383003d1">JobSystemSingleThreaded::mDummyBarrier</a></div><div class="ttdeci">BarrierImpl mDummyBarrier</div><div class="ttdoc">Shared barrier since the barrier implementation does nothing.</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:55</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html_a46ee269e0b3c8933cade0f12dbd47d88"><div class="ttname"><a href="class_job_system_single_threaded.html#a46ee269e0b3c8933cade0f12dbd47d88">JobSystemSingleThreaded::mJobs</a></div><div class="ttdeci">AvailableJobs mJobs</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:59</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html_a4e99aebfb2308cf3c4bdd8e54bb71799"><div class="ttname"><a href="class_job_system_single_threaded.html#a4e99aebfb2308cf3c4bdd8e54bb71799">JobSystemSingleThreaded::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> JobSystemSingleThreaded.h:27</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html_a9c9d96208c3ff6d3fc601da994b56198"><div class="ttname"><a href="class_job_system_single_threaded.html#a9c9d96208c3ff6d3fc601da994b56198">JobSystemSingleThreaded::JobSystemSingleThreaded</a></div><div class="ttdeci">JobSystemSingleThreaded(uint inMaxJobs)</div><div class="ttdef"><b>Definition</b> JobSystemSingleThreaded.h:20</div></div>
- <div class="ttc" id="aclass_job_system_single_threaded_html_ac04954b37964301fdc8c569fff04a6eb"><div class="ttname"><a href="class_job_system_single_threaded.html#ac04954b37964301fdc8c569fff04a6eb">JobSystemSingleThreaded::JobSystemSingleThreaded</a></div><div class="ttdeci">JPH_OVERRIDE_NEW_DELETE JobSystemSingleThreaded()=default</div><div class="ttdoc">Constructor.</div></div>
- </div><!-- fragment --></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="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_single_threaded_8h.html">JobSystemSingleThreaded.h</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>
|