cpp
/
JoltPhysics
peilaus alkaen https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599
							<!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: JobSystem::Job 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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_job_system_1_1_job.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_job_system_1_1_job-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">JobSystem::Job Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A class that contains information for a single unit of work.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_job_system_8h_source.html">JobSystem.h</a>&gt;</code></p>
<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:a50f9de63538bb632101548fef86258e1" id="r_a50f9de63538bb632101548fef86258e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50f9de63538bb632101548fef86258e1">Job</a> (const char *inJobName, <a class="el" href="_color_8h.html#a3daf1ee578b30da1860ff132c70474b5">ColorArg</a> inColor, <a class="el" href="class_job_system.html">JobSystem</a> *inJobSystem, const <a class="el" href="class_job_system.html#ae31ef61a509934f03d4705aec19c61f5">JobFunction</a> &amp;inJobFunction, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumDependencies)</td></tr>
<tr class="memdesc:a50f9de63538bb632101548fef86258e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a50f9de63538bb632101548fef86258e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3922bb7442e7e778cec6a8ea984f454" id="r_aa3922bb7442e7e778cec6a8ea984f454"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_job_system.html">JobSystem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3922bb7442e7e778cec6a8ea984f454">GetJobSystem</a> ()</td></tr>
<tr class="memdesc:aa3922bb7442e7e778cec6a8ea984f454"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the jobs system to which this job belongs.  <br /></td></tr>
<tr class="separator:aa3922bb7442e7e778cec6a8ea984f454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6b5861562063d42cfa3c68f45c12b2d" id="r_ac6b5861562063d42cfa3c68f45c12b2d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6b5861562063d42cfa3c68f45c12b2d">AddRef</a> ()</td></tr>
<tr class="memdesc:ac6b5861562063d42cfa3c68f45c12b2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object.  <br /></td></tr>
<tr class="separator:ac6b5861562063d42cfa3c68f45c12b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46cad8e24ec8ff788b41e8aea53a2e27" id="r_a46cad8e24ec8ff788b41e8aea53a2e27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46cad8e24ec8ff788b41e8aea53a2e27">Release</a> ()</td></tr>
<tr class="separator:a46cad8e24ec8ff788b41e8aea53a2e27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7686a4762d0dfe746f0b46edfcae3d6d" id="r_a7686a4762d0dfe746f0b46edfcae3d6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7686a4762d0dfe746f0b46edfcae3d6d">AddDependency</a> (int inCount)</td></tr>
<tr class="memdesc:a7686a4762d0dfe746f0b46edfcae3d6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to the dependency counter.  <br /></td></tr>
<tr class="separator:a7686a4762d0dfe746f0b46edfcae3d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59a4638f7edcbfd30f47f096f0f984f1" id="r_a59a4638f7edcbfd30f47f096f0f984f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59a4638f7edcbfd30f47f096f0f984f1">RemoveDependency</a> (int inCount)</td></tr>
<tr class="separator:a59a4638f7edcbfd30f47f096f0f984f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4411bbad4af5361b85db233bd0adb43" id="r_ae4411bbad4af5361b85db233bd0adb43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae4411bbad4af5361b85db233bd0adb43">RemoveDependencyAndQueue</a> (int inCount)</td></tr>
<tr class="separator:ae4411bbad4af5361b85db233bd0adb43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83a4dee7e40f01cab6eafbafa53a4efc" id="r_a83a4dee7e40f01cab6eafbafa53a4efc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a83a4dee7e40f01cab6eafbafa53a4efc">SetBarrier</a> (<a class="el" href="class_job_system_1_1_barrier.html">Barrier</a> *inBarrier)</td></tr>
<tr class="memdesc:a83a4dee7e40f01cab6eafbafa53a4efc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the job barrier that this job belongs to and returns false if this was not possible because the job already finished.  <br /></td></tr>
<tr class="separator:a83a4dee7e40f01cab6eafbafa53a4efc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51718f809ac43edfcd1a3ae87acc2bd4" id="r_a51718f809ac43edfcd1a3ae87acc2bd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51718f809ac43edfcd1a3ae87acc2bd4">Execute</a> ()</td></tr>
<tr class="memdesc:a51718f809ac43edfcd1a3ae87acc2bd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the job function, returns the number of dependencies that this job still has or cExecutingState or cDoneState.  <br /></td></tr>
<tr class="separator:a51718f809ac43edfcd1a3ae87acc2bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa223bb40f3b9a54e69440ae309a661f" id="r_aaa223bb40f3b9a54e69440ae309a661f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa223bb40f3b9a54e69440ae309a661f">CanBeExecuted</a> () const</td></tr>
<tr class="memdesc:aaa223bb40f3b9a54e69440ae309a661f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if the job can be executed.  <br /></td></tr>
<tr class="separator:aaa223bb40f3b9a54e69440ae309a661f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd9fad54e1b18a2a0c9795e86e222875" id="r_abd9fad54e1b18a2a0c9795e86e222875"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd9fad54e1b18a2a0c9795e86e222875">IsDone</a> () const</td></tr>
<tr class="memdesc:abd9fad54e1b18a2a0c9795e86e222875"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if the job finished executing.  <br /></td></tr>
<tr class="separator:abd9fad54e1b18a2a0c9795e86e222875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a426bcf2faa48d1ba4cf7874a32910f83" id="r_a426bcf2faa48d1ba4cf7874a32910f83"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a426bcf2faa48d1ba4cf7874a32910f83">GetName</a> () const</td></tr>
<tr class="memdesc:a426bcf2faa48d1ba4cf7874a32910f83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the job.  <br /></td></tr>
<tr class="separator:a426bcf2faa48d1ba4cf7874a32910f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:add5d0be4f40149e9b66ebaf3ed99f96b" id="r_add5d0be4f40149e9b66ebaf3ed99f96b"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#add5d0be4f40149e9b66ebaf3ed99f96b">cExecutingState</a> = 0xe0e0e0e0</td></tr>
<tr class="memdesc:add5d0be4f40149e9b66ebaf3ed99f96b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value of mNumDependencies when job is executing.  <br /></td></tr>
<tr class="separator:add5d0be4f40149e9b66ebaf3ed99f96b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa36ca70b191d31c36707cf642167b926" id="r_aa36ca70b191d31c36707cf642167b926"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa36ca70b191d31c36707cf642167b926">cDoneState</a> = 0xd0d0d0d0</td></tr>
<tr class="memdesc:aa36ca70b191d31c36707cf642167b926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value of mNumDependencies when job is done executing.  <br /></td></tr>
<tr class="separator:aa36ca70b191d31c36707cf642167b926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1be0a8e2bcb376eee7915050b17739" id="r_a0d1be0a8e2bcb376eee7915050b17739"><td class="memItemLeft" align="right" valign="top">static constexpr intptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d1be0a8e2bcb376eee7915050b17739">cBarrierDoneState</a> = ~intptr_t(0)</td></tr>
<tr class="memdesc:a0d1be0a8e2bcb376eee7915050b17739"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to use when the barrier has been triggered.  <br /></td></tr>
<tr class="separator:a0d1be0a8e2bcb376eee7915050b17739"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that contains information for a single unit of work. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a50f9de63538bb632101548fef86258e1" name="a50f9de63538bb632101548fef86258e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50f9de63538bb632101548fef86258e1">&#9670;&#160;</a></span>Job()</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> JobSystem::Job::Job </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>inJobName</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"><a class="el" href="class_job_system.html">JobSystem</a> *</td>          <td class="paramname"><span class="paramname"><em>inJobSystem</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> &amp;</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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7686a4762d0dfe746f0b46edfcae3d6d" name="a7686a4762d0dfe746f0b46edfcae3d6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7686a4762d0dfe746f0b46edfcae3d6d">&#9670;&#160;</a></span>AddDependency()</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="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> void JobSystem::Job::AddDependency </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add to the dependency counter. </p>

</div>
</div>
<a id="ac6b5861562063d42cfa3c68f45c12b2d" name="ac6b5861562063d42cfa3c68f45c12b2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6b5861562063d42cfa3c68f45c12b2d">&#9670;&#160;</a></span>AddRef()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystem::Job::AddRef </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add or release a reference to this object. </p>

</div>
</div>
<a id="aaa223bb40f3b9a54e69440ae309a661f" name="aaa223bb40f3b9a54e69440ae309a661f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa223bb40f3b9a54e69440ae309a661f">&#9670;&#160;</a></span>CanBeExecuted()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool JobSystem::Job::CanBeExecuted </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Test if the job can be executed. </p>

</div>
</div>
<a id="a51718f809ac43edfcd1a3ae87acc2bd4" name="a51718f809ac43edfcd1a3ae87acc2bd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51718f809ac43edfcd1a3ae87acc2bd4">&#9670;&#160;</a></span>Execute()</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="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> JobSystem::Job::Execute </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Run the job function, returns the number of dependencies that this job still has or cExecutingState or cDoneState. </p>

</div>
</div>
<a id="aa3922bb7442e7e778cec6a8ea984f454" name="aa3922bb7442e7e778cec6a8ea984f454"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3922bb7442e7e778cec6a8ea984f454">&#9670;&#160;</a></span>GetJobSystem()</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.html">JobSystem</a> * JobSystem::Job::GetJobSystem </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the jobs system to which this job belongs. </p>

</div>
</div>
<a id="a426bcf2faa48d1ba4cf7874a32910f83" name="a426bcf2faa48d1ba4cf7874a32910f83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a426bcf2faa48d1ba4cf7874a32910f83">&#9670;&#160;</a></span>GetName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char * JobSystem::Job::GetName </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the name of the job. </p>

</div>
</div>
<a id="abd9fad54e1b18a2a0c9795e86e222875" name="abd9fad54e1b18a2a0c9795e86e222875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd9fad54e1b18a2a0c9795e86e222875">&#9670;&#160;</a></span>IsDone()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool JobSystem::Job::IsDone </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Test if the job finished executing. </p>

</div>
</div>
<a id="a46cad8e24ec8ff788b41e8aea53a2e27" name="a46cad8e24ec8ff788b41e8aea53a2e27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46cad8e24ec8ff788b41e8aea53a2e27">&#9670;&#160;</a></span>Release()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystem::Job::Release </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a59a4638f7edcbfd30f47f096f0f984f1" name="a59a4638f7edcbfd30f47f096f0f984f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59a4638f7edcbfd30f47f096f0f984f1">&#9670;&#160;</a></span>RemoveDependency()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool JobSystem::Job::RemoveDependency </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Remove from the dependency counter. Returns true whenever the dependency counter reaches zero and if it does it is no longer valid to call the AddDependency/RemoveDependency functions. </p>

</div>
</div>
<a id="ae4411bbad4af5361b85db233bd0adb43" name="ae4411bbad4af5361b85db233bd0adb43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4411bbad4af5361b85db233bd0adb43">&#9670;&#160;</a></span>RemoveDependencyAndQueue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void JobSystem::Job::RemoveDependencyAndQueue </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Remove from the dependency counter. <a class="el" href="class_job_system_1_1_job.html" title="A class that contains information for a single unit of work.">Job</a> will be queued whenever the dependency counter reaches zero and if it does it is no longer valid to call the AddDependency/RemoveDependency functions. </p>

</div>
</div>
<a id="a83a4dee7e40f01cab6eafbafa53a4efc" name="a83a4dee7e40f01cab6eafbafa53a4efc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83a4dee7e40f01cab6eafbafa53a4efc">&#9670;&#160;</a></span>SetBarrier()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool JobSystem::Job::SetBarrier </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the job barrier that this job belongs to and returns false if this was not possible because the job already finished. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0d1be0a8e2bcb376eee7915050b17739" name="a0d1be0a8e2bcb376eee7915050b17739"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1be0a8e2bcb376eee7915050b17739">&#9670;&#160;</a></span>cBarrierDoneState</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">intptr_t JobSystem::Job::cBarrierDoneState = ~intptr_t(0)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Value to use when the barrier has been triggered. </p>

</div>
</div>
<a id="aa36ca70b191d31c36707cf642167b926" name="aa36ca70b191d31c36707cf642167b926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa36ca70b191d31c36707cf642167b926">&#9670;&#160;</a></span>cDoneState</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="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> JobSystem::Job::cDoneState = 0xd0d0d0d0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Value of mNumDependencies when job is done executing. </p>

</div>
</div>
<a id="add5d0be4f40149e9b66ebaf3ed99f96b" name="add5d0be4f40149e9b66ebaf3ed99f96b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add5d0be4f40149e9b66ebaf3ed99f96b">&#9670;&#160;</a></span>cExecutingState</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="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> JobSystem::Job::cExecutingState = 0xe0e0e0e0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Value of mNumDependencies when job is executing. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Core/<a class="el" href="_job_system_8h_source.html">JobSystem.h</a></li>
<li>Jolt/Core/<a class="el" href="_job_system_8inl_source.html">JobSystem.inl</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.html">JobSystem</a></li><li class="navelem"><a class="el" href="class_job_system_1_1_job.html">Job</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>