cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
							<!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::JobHandle 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_handle.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-methods">Static Public Member Functions</a> &#124;
<a href="class_job_system_1_1_job_handle-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">JobSystem::JobHandle Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_job_system_8h_source.html">JobSystem.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for JobSystem::JobHandle:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_job_system_1_1_job_handle.png" usemap="#JobSystem::JobHandle_map" alt=""/>
  <map id="JobSystem::JobHandle_map" name="JobSystem::JobHandle_map">
<area href="class_ref.html" alt="Ref&lt; Job &gt;" shape="rect" coords="0,0,140,24"/>
  </map>
</div></div>
<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:a07f9178968f17e7bcb8b876f46ee916d" id="r_a07f9178968f17e7bcb8b876f46ee916d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07f9178968f17e7bcb8b876f46ee916d">JobHandle</a> ()=default</td></tr>
<tr class="memdesc:a07f9178968f17e7bcb8b876f46ee916d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a07f9178968f17e7bcb8b876f46ee916d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a968f1e7b128e82c864214452ad9ae168" id="r_a968f1e7b128e82c864214452ad9ae168"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a968f1e7b128e82c864214452ad9ae168">JobHandle</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;inHandle)=default</td></tr>
<tr class="separator:a968f1e7b128e82c864214452ad9ae168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5324a68c829e11b6f9cfbcb27ec6451d" id="r_a5324a68c829e11b6f9cfbcb27ec6451d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5324a68c829e11b6f9cfbcb27ec6451d">JobHandle</a> (<a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&amp;inHandle) noexcept</td></tr>
<tr class="separator:a5324a68c829e11b6f9cfbcb27ec6451d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08f33876c4c56f09acc8447c68af002a" id="r_a08f33876c4c56f09acc8447c68af002a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08f33876c4c56f09acc8447c68af002a">JobHandle</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob)</td></tr>
<tr class="memdesc:a08f33876c4c56f09acc8447c68af002a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, only to be used by <a class="el" href="class_job_system.html">JobSystem</a>.  <br /></td></tr>
<tr class="separator:a08f33876c4c56f09acc8447c68af002a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe0bc1784be03e007aedfc86a8a0b99" id="r_adfe0bc1784be03e007aedfc86a8a0b99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfe0bc1784be03e007aedfc86a8a0b99">operator=</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;inHandle)=default</td></tr>
<tr class="memdesc:adfe0bc1784be03e007aedfc86a8a0b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment.  <br /></td></tr>
<tr class="separator:adfe0bc1784be03e007aedfc86a8a0b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a434a0bf97c5ade28fcf116de7bd1c0e1" id="r_a434a0bf97c5ade28fcf116de7bd1c0e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a434a0bf97c5ade28fcf116de7bd1c0e1">operator=</a> (<a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&amp;inHandle) noexcept=default</td></tr>
<tr class="separator:a434a0bf97c5ade28fcf116de7bd1c0e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f060c8caed0f0d1a5cfa45490790529" id="r_a8f060c8caed0f0d1a5cfa45490790529"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f060c8caed0f0d1a5cfa45490790529">IsValid</a> () const</td></tr>
<tr class="memdesc:a8f060c8caed0f0d1a5cfa45490790529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this handle contains a job.  <br /></td></tr>
<tr class="separator:a8f060c8caed0f0d1a5cfa45490790529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787e04af05eea5f3eda568956cca9f10" id="r_a787e04af05eea5f3eda568956cca9f10"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a787e04af05eea5f3eda568956cca9f10">IsDone</a> () const</td></tr>
<tr class="memdesc:a787e04af05eea5f3eda568956cca9f10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this job has finished executing.  <br /></td></tr>
<tr class="separator:a787e04af05eea5f3eda568956cca9f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0a10c0398474dbf0ffe9b5866775abb" id="r_af0a10c0398474dbf0ffe9b5866775abb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0a10c0398474dbf0ffe9b5866775abb">AddDependency</a> (int inCount=1) const</td></tr>
<tr class="memdesc:af0a10c0398474dbf0ffe9b5866775abb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to the dependency counter.  <br /></td></tr>
<tr class="separator:af0a10c0398474dbf0ffe9b5866775abb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25f723a35202461e725cc3ad6cc166bb" id="r_a25f723a35202461e725cc3ad6cc166bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25f723a35202461e725cc3ad6cc166bb">RemoveDependency</a> (int inCount=1) const</td></tr>
<tr class="separator:a25f723a35202461e725cc3ad6cc166bb"><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-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0daface7b509f0f9bd5b03a33554b6c4" id="r_a0daface7b509f0f9bd5b03a33554b6c4"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0daface7b509f0f9bd5b03a33554b6c4">sRemoveDependencies</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> *inHandles, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumHandles, int inCount=1)</td></tr>
<tr class="memdesc:a0daface7b509f0f9bd5b03a33554b6c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a dependency from a batch of jobs at once, this can be more efficient than removing them one by one as it requires less locking.  <br /></td></tr>
<tr class="separator:a0daface7b509f0f9bd5b03a33554b6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a822d3ea702c61fe9aa32b2c6e6925749" id="r_a822d3ea702c61fe9aa32b2c6e6925749"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> N&gt; </td></tr>
<tr class="memitem:a822d3ea702c61fe9aa32b2c6e6925749"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a822d3ea702c61fe9aa32b2c6e6925749">sRemoveDependencies</a> (<a class="el" href="class_static_array.html">StaticArray</a>&lt; <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a>, N &gt; &amp;inHandles, int inCount=1)</td></tr>
<tr class="memdesc:a822d3ea702c61fe9aa32b2c6e6925749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to remove dependencies on a static array of job handles.  <br /></td></tr>
<tr class="separator:a822d3ea702c61fe9aa32b2c6e6925749"><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 job handle contains a reference to a job. The job will be deleted as soon as there are no JobHandles. referring to the job and when it is not in the job queue / being processed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a07f9178968f17e7bcb8b876f46ee916d" name="a07f9178968f17e7bcb8b876f46ee916d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07f9178968f17e7bcb8b876f46ee916d">&#9670;&#160;</a></span>JobHandle() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JobSystem::JobHandle::JobHandle </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 class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>

</div>
</div>
<a id="a968f1e7b128e82c864214452ad9ae168" name="a968f1e7b128e82c864214452ad9ae168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a968f1e7b128e82c864214452ad9ae168">&#9670;&#160;</a></span>JobHandle() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JobSystem::JobHandle::JobHandle </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inHandle</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">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a5324a68c829e11b6f9cfbcb27ec6451d" name="a5324a68c829e11b6f9cfbcb27ec6451d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5324a68c829e11b6f9cfbcb27ec6451d">&#9670;&#160;</a></span>JobHandle() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JobSystem::JobHandle::JobHandle </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inHandle</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">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a08f33876c4c56f09acc8447c68af002a" name="a08f33876c4c56f09acc8447c68af002a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08f33876c4c56f09acc8447c68af002a">&#9670;&#160;</a></span>JobHandle() <span class="overload">[4/4]</span></h2>

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

<p>Constructor, only to be used by <a class="el" href="class_job_system.html">JobSystem</a>. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af0a10c0398474dbf0ffe9b5866775abb" name="af0a10c0398474dbf0ffe9b5866775abb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0a10c0398474dbf0ffe9b5866775abb">&#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">void JobSystem::JobHandle::AddDependency </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</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>Add to the dependency counter. </p>

</div>
</div>
<a id="a787e04af05eea5f3eda568956cca9f10" name="a787e04af05eea5f3eda568956cca9f10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a787e04af05eea5f3eda568956cca9f10">&#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::JobHandle::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>Check if this job has finished executing. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool JobSystem::JobHandle::IsValid </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>Check if this handle contains a job. </p>

</div>
</div>
<a id="adfe0bc1784be03e007aedfc86a8a0b99" name="adfe0bc1784be03e007aedfc86a8a0b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfe0bc1784be03e007aedfc86a8a0b99">&#9670;&#160;</a></span>operator=() <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="class_job_system_1_1_job_handle.html">JobHandle</a> &amp; JobSystem::JobHandle::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inHandle</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">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Assignment. </p>

</div>
</div>
<a id="a434a0bf97c5ade28fcf116de7bd1c0e1" name="a434a0bf97c5ade28fcf116de7bd1c0e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a434a0bf97c5ade28fcf116de7bd1c0e1">&#9670;&#160;</a></span>operator=() <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"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp; JobSystem::JobHandle::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inHandle</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">default</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a25f723a35202461e725cc3ad6cc166bb" name="a25f723a35202461e725cc3ad6cc166bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25f723a35202461e725cc3ad6cc166bb">&#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">void JobSystem::JobHandle::RemoveDependency </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</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>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 start 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="a0daface7b509f0f9bd5b03a33554b6c4" name="a0daface7b509f0f9bd5b03a33554b6c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0daface7b509f0f9bd5b03a33554b6c4">&#9670;&#160;</a></span>sRemoveDependencies() <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">void JobSystem::JobHandle::sRemoveDependencies </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> *</td>          <td class="paramname"><span class="paramname"><em>inHandles</em></span>, </td>
        </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>inNumHandles</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Remove a dependency from a batch of jobs at once, this can be more efficient than removing them one by one as it requires less locking. </p>

</div>
</div>
<a id="a822d3ea702c61fe9aa32b2c6e6925749" name="a822d3ea702c61fe9aa32b2c6e6925749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a822d3ea702c61fe9aa32b2c6e6925749">&#9670;&#160;</a></span>sRemoveDependencies() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> N&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void JobSystem::JobHandle::sRemoveDependencies </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_static_array.html">StaticArray</a>&lt; <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a>, N &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>inHandles</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inCount</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Helper function to remove dependencies on a static array of job handles. </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_handle.html">JobHandle</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>