| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622 |
- <!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: JobSystemSingleThreaded Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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('class_job_system_single_threaded.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pro-types">Protected Types</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="class_job_system_single_threaded-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">JobSystemSingleThreaded Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
- </div><!--header-->
- <div class="contents">
- <p>Implementation of a <a class="el" href="class_job_system.html">JobSystem</a> without threads, runs jobs as soon as they are added.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for JobSystemSingleThreaded:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_job_system_single_threaded.png" usemap="#JobSystemSingleThreaded_map" alt=""/>
- <map id="JobSystemSingleThreaded_map" name="JobSystemSingleThreaded_map">
- <area href="class_job_system.html" alt="JobSystem" shape="rect" coords="0,56,162,80"/>
- <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,162,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:ac04954b37964301fdc8c569fff04a6eb" id="r_ac04954b37964301fdc8c569fff04a6eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac04954b37964301fdc8c569fff04a6eb">JobSystemSingleThreaded</a> ()=default</td></tr>
- <tr class="memdesc:ac04954b37964301fdc8c569fff04a6eb"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:ac04954b37964301fdc8c569fff04a6eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9c9d96208c3ff6d3fc601da994b56198" id="r_a9c9d96208c3ff6d3fc601da994b56198"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:a9c9d96208c3ff6d3fc601da994b56198"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9a7a97646eaa417b4860df72739a64d9" id="r_a9a7a97646eaa417b4860df72739a64d9"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a9a7a97646eaa417b4860df72739a64d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4e99aebfb2308cf3c4bdd8e54bb71799" id="r_a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e99aebfb2308cf3c4bdd8e54bb71799">GetMaxConcurrency</a> () const override</td></tr>
- <tr class="memdesc:a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="mdescLeft"> </td><td class="mdescRight">Get maximum number of concurrently executing jobs. <br /></td></tr>
- <tr class="separator:a4e99aebfb2308cf3c4bdd8e54bb71799"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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> &inJobFunction, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumDependencies=0) override</td></tr>
- <tr class="separator:ac183b901c9be0f04f21ff493cb5b2ec7"><td class="memSeparator" colspan="2"> </td></tr>
- <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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ade901f3e457e5f60b071388bc6557778">CreateBarrier</a> () override</td></tr>
- <tr class="memdesc:ade901f3e457e5f60b071388bc6557778"><td class="mdescLeft"> </td><td class="mdescRight">Create a new barrier, used to wait on jobs. <br /></td></tr>
- <tr class="separator:ade901f3e457e5f60b071388bc6557778"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9333b0d4cb69ade4b4045b518c77a120" id="r_a9333b0d4cb69ade4b4045b518c77a120"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="memdesc:a9333b0d4cb69ade4b4045b518c77a120"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a barrier when it is no longer used. The barrier should be empty at this point. <br /></td></tr>
- <tr class="separator:a9333b0d4cb69ade4b4045b518c77a120"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa491ca6999f7f2285a79b114b696e6ac" id="r_aa491ca6999f7f2285a79b114b696e6ac"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="memdesc:aa491ca6999f7f2285a79b114b696e6ac"><td class="mdescLeft"> </td><td class="mdescRight">Wait for a set of jobs to be finished, note that only 1 thread can be waiting on a barrier at a time. <br /></td></tr>
- <tr class="separator:aa491ca6999f7f2285a79b114b696e6ac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_job_system')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
- <tr class="memitem:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system" id="r_aaaf28c0a93f2d52eb2c936807f9e8ec9"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system.html#aaaf28c0a93f2d52eb2c936807f9e8ec9">~JobSystem</a> ()=default</td></tr>
- <tr class="memdesc:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:aaaf28c0a93f2d52eb2c936807f9e8ec9 inherit pub_methods_class_job_system"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
- <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
- <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
- <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void </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> &)=delete</td></tr>
- <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
- Protected Types</h2></td></tr>
- <tr class="memitem:ae327b71ac563cfe1d2c5623511291450" id="r_ae327b71ac563cfe1d2c5623511291450"><td class="memItemLeft" align="right" valign="top">using </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><<a class="el" href="class_job_system_1_1_job.html">Job</a>></td></tr>
- <tr class="memdesc:ae327b71ac563cfe1d2c5623511291450"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_array.html">Array</a> of jobs (fixed size) <br /></td></tr>
- <tr class="separator:ae327b71ac563cfe1d2c5623511291450"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:ac3eead674dbe8a93398dcbc13b324da5" id="r_ac3eead674dbe8a93398dcbc13b324da5"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="memdesc:ac3eead674dbe8a93398dcbc13b324da5"><td class="mdescLeft"> </td><td class="mdescRight">Adds a job to the job queue. <br /></td></tr>
- <tr class="separator:ac3eead674dbe8a93398dcbc13b324da5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1581f359dde3922b6b3f973ec78c73df" id="r_a1581f359dde3922b6b3f973ec78c73df"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="memdesc:a1581f359dde3922b6b3f973ec78c73df"><td class="mdescLeft"> </td><td class="mdescRight">Adds a number of jobs at once to the job queue. <br /></td></tr>
- <tr class="separator:a1581f359dde3922b6b3f973ec78c73df"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abb23fc08db8c653059c7ab32e44fd7fd" id="r_abb23fc08db8c653059c7ab32e44fd7fd"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="memdesc:abb23fc08db8c653059c7ab32e44fd7fd"><td class="mdescLeft"> </td><td class="mdescRight">Frees a job. <br /></td></tr>
- <tr class="separator:abb23fc08db8c653059c7ab32e44fd7fd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_job_system')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ef030c1327f4ebf4eb7c5ef383003d1">mDummyBarrier</a></td></tr>
- <tr class="memdesc:a0ef030c1327f4ebf4eb7c5ef383003d1"><td class="mdescLeft"> </td><td class="mdescRight">Shared barrier since the barrier implementation does nothing. <br /></td></tr>
- <tr class="separator:a0ef030c1327f4ebf4eb7c5ef383003d1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a46ee269e0b3c8933cade0f12dbd47d88" id="r_a46ee269e0b3c8933cade0f12dbd47d88"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ae327b71ac563cfe1d2c5623511291450">AvailableJobs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a46ee269e0b3c8933cade0f12dbd47d88">mJobs</a></td></tr>
- <tr class="separator:a46ee269e0b3c8933cade0f12dbd47d88"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_types_class_job_system"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_job_system')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_job_system.html">JobSystem</a></td></tr>
- <tr class="memitem:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system" id="r_ae31ef61a509934f03d4705aec19c61f5"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> = function<void()></td></tr>
- <tr class="memdesc:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system"><td class="mdescLeft"> </td><td class="mdescRight">Main function of the job. <br /></td></tr>
- <tr class="separator:ae31ef61a509934f03d4705aec19c61f5 inherit pub_types_class_job_system"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Implementation of a <a class="el" href="class_job_system.html">JobSystem</a> without threads, runs jobs as soon as they are added. </p>
- </div><h2 class="groupheader">Member Typedef Documentation</h2>
- <a id="ae327b71ac563cfe1d2c5623511291450" name="ae327b71ac563cfe1d2c5623511291450"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae327b71ac563cfe1d2c5623511291450">◆ </a></span>AvailableJobs</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">using <a class="el" href="#ae327b71ac563cfe1d2c5623511291450">JobSystemSingleThreaded::AvailableJobs</a> = <a class="el" href="class_fixed_size_free_list.html">FixedSizeFreeList</a><<a class="el" href="class_job_system_1_1_job.html">Job</a>></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="class_array.html">Array</a> of jobs (fixed size) </p>
- </div>
- </div>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="ac04954b37964301fdc8c569fff04a6eb" name="ac04954b37964301fdc8c569fff04a6eb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac04954b37964301fdc8c569fff04a6eb">◆ </a></span>JobSystemSingleThreaded() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> JobSystemSingleThreaded::JobSystemSingleThreaded </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">default</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor. </p>
- </div>
- </div>
- <a id="a9c9d96208c3ff6d3fc601da994b56198" name="a9c9d96208c3ff6d3fc601da994b56198"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9c9d96208c3ff6d3fc601da994b56198">◆ </a></span>JobSystemSingleThreaded() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">JobSystemSingleThreaded::JobSystemSingleThreaded </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inMaxJobs</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ade901f3e457e5f60b071388bc6557778" name="ade901f3e457e5f60b071388bc6557778"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade901f3e457e5f60b071388bc6557778">◆ </a></span>CreateBarrier()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_job_system_1_1_barrier.html">JobSystem::Barrier</a> * JobSystemSingleThreaded::CreateBarrier </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a new barrier, used to wait on jobs. </p>
- <p>Implements <a class="el" href="class_job_system.html#a2bd7c3efdc8f934b728ee1787e0bd58e">JobSystem</a>.</p>
- </div>
- </div>
- <a id="ac183b901c9be0f04f21ff493cb5b2ec7" name="ac183b901c9be0f04f21ff493cb5b2ec7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac183b901c9be0f04f21ff493cb5b2ec7">◆ </a></span>CreateJob()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> JobSystemSingleThreaded::CreateJob </td>
- <td>(</td>
- <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_color_8h.html#a3daf1ee578b30da1860ff132c70474b5">ColorArg</a></td> <td class="paramname"><span class="paramname"><em>inColor</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> &</td> <td class="paramname"><span class="paramname"><em>inJobFunction</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inNumDependencies</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a new job, the job is started immediately if inNumDependencies == 0 otherwise it starts when RemoveDependency causes the dependency counter to reach 0. </p>
- <p>Implements <a class="el" href="class_job_system.html#a0766c8acd5ed9ef0e6baf1c2b8f3c38b">JobSystem</a>.</p>
- </div>
- </div>
- <a id="a9333b0d4cb69ade4b4045b518c77a120" name="a9333b0d4cb69ade4b4045b518c77a120"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9333b0d4cb69ade4b4045b518c77a120">◆ </a></span>DestroyBarrier()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JobSystemSingleThreaded::DestroyBarrier </td>
- <td>(</td>
- <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>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destroy a barrier when it is no longer used. The barrier should be empty at this point. </p>
- <p>Implements <a class="el" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373">JobSystem</a>.</p>
- </div>
- </div>
- <a id="abb23fc08db8c653059c7ab32e44fd7fd" name="abb23fc08db8c653059c7ab32e44fd7fd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abb23fc08db8c653059c7ab32e44fd7fd">◆ </a></span>FreeJob()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JobSystemSingleThreaded::FreeJob </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> *</td> <td class="paramname"><span class="paramname"><em>inJob</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Frees a job. </p>
- <p>Implements <a class="el" href="class_job_system.html#aa74329d956a01e3f2f219ea22bdc5097">JobSystem</a>.</p>
- </div>
- </div>
- <a id="a4e99aebfb2308cf3c4bdd8e54bb71799" name="a4e99aebfb2308cf3c4bdd8e54bb71799"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4e99aebfb2308cf3c4bdd8e54bb71799">◆ </a></span>GetMaxConcurrency()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int JobSystemSingleThreaded::GetMaxConcurrency </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get maximum number of concurrently executing jobs. </p>
- <p>Implements <a class="el" href="class_job_system.html#a5953ad34be5c47e7896b87ac7409b7d7">JobSystem</a>.</p>
- </div>
- </div>
- <a id="a9a7a97646eaa417b4860df72739a64d9" name="a9a7a97646eaa417b4860df72739a64d9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9a7a97646eaa417b4860df72739a64d9">◆ </a></span>Init()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> void JobSystemSingleThreaded::Init </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inMaxJobs</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initialize the job system </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inMaxJobs</td><td>Max number of jobs that can be allocated at any time </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ac3eead674dbe8a93398dcbc13b324da5" name="ac3eead674dbe8a93398dcbc13b324da5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac3eead674dbe8a93398dcbc13b324da5">◆ </a></span>QueueJob()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JobSystemSingleThreaded::QueueJob </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> *</td> <td class="paramname"><span class="paramname"><em>inJob</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Adds a job to the job queue. </p>
- <p>Implements <a class="el" href="class_job_system.html#ae6bae9c5725c2009c8e9a2d79f60cb40">JobSystem</a>.</p>
- </div>
- </div>
- <a id="a1581f359dde3922b6b3f973ec78c73df" name="a1581f359dde3922b6b3f973ec78c73df"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1581f359dde3922b6b3f973ec78c73df">◆ </a></span>QueueJobs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JobSystemSingleThreaded::QueueJobs </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_job_system_1_1_job.html">Job</a> **</td> <td class="paramname"><span class="paramname"><em>inJobs</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumJobs</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Adds a number of jobs at once to the job queue. </p>
- <p>Implements <a class="el" href="class_job_system.html#a5820eef46d040e6ae17e51a828201118">JobSystem</a>.</p>
- </div>
- </div>
- <a id="aa491ca6999f7f2285a79b114b696e6ac" name="aa491ca6999f7f2285a79b114b696e6ac"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa491ca6999f7f2285a79b114b696e6ac">◆ </a></span>WaitForJobs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JobSystemSingleThreaded::WaitForJobs </td>
- <td>(</td>
- <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>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <p>Implements <a class="el" href="class_job_system.html#a32e93cf0a95e8893978cf1ee92eb41d7">JobSystem</a>.</p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a0ef030c1327f4ebf4eb7c5ef383003d1" name="a0ef030c1327f4ebf4eb7c5ef383003d1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0ef030c1327f4ebf4eb7c5ef383003d1">◆ </a></span>mDummyBarrier</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html">BarrierImpl</a> JobSystemSingleThreaded::mDummyBarrier</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Shared barrier since the barrier implementation does nothing. </p>
- </div>
- </div>
- <a id="a46ee269e0b3c8933cade0f12dbd47d88" name="a46ee269e0b3c8933cade0f12dbd47d88"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a46ee269e0b3c8933cade0f12dbd47d88">◆ </a></span>mJobs</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="#ae327b71ac563cfe1d2c5623511291450">AvailableJobs</a> JobSystemSingleThreaded::mJobs</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Core/<a class="el" href="_job_system_single_threaded_8h_source.html">JobSystemSingleThreaded.h</a></li>
- <li>Jolt/Core/<a class="el" href="_job_system_single_threaded_8cpp.html">JobSystemSingleThreaded.cpp</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_job_system_single_threaded.html">JobSystemSingleThreaded</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>
|