cpp
/
JoltPhysics
同期ミラー https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
							<!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::Barrier 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_barrier.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="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_job_system_1_1_barrier-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">JobSystem::Barrier Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>A job barrier keeps track of a number of jobs and allows waiting until they are all completed.  
 <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>
<div class="dynheader">
Inheritance diagram for JobSystem::Barrier:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_job_system_1_1_barrier.png" usemap="#JobSystem::Barrier_map" alt=""/>
  <map id="JobSystem::Barrier_map" name="JobSystem::Barrier_map">
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,230,24"/>
<area href="class_job_system_single_threaded_1_1_barrier_impl.html" alt="JobSystemSingleThreaded::BarrierImpl" shape="rect" coords="0,112,230,136"/>
  </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:afcf8f345a7a19e1399c4899942ed49c4" id="r_afcf8f345a7a19e1399c4899942ed49c4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afcf8f345a7a19e1399c4899942ed49c4">AddJob</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> &amp;inJob)=0</td></tr>
<tr class="separator:afcf8f345a7a19e1399c4899942ed49c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad62875b2d5b89282bfaae824cac1a476" id="r_ad62875b2d5b89282bfaae824cac1a476"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad62875b2d5b89282bfaae824cac1a476">AddJobs</a> (const <a class="el" href="class_job_system_1_1_job_handle.html">JobHandle</a> *inHandles, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumHandles)=0</td></tr>
<tr class="separator:ad62875b2d5b89282bfaae824cac1a476"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</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:aa7553c8c987ca8bb810c2715ef8ffbbd" id="r_aa7553c8c987ca8bb810c2715ef8ffbbd"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7553c8c987ca8bb810c2715ef8ffbbd">~Barrier</a> ()=default</td></tr>
<tr class="memdesc:aa7553c8c987ca8bb810c2715ef8ffbbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor, you should call <a class="el" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373" title="Destroy a barrier when it is no longer used. The barrier should be empty at this point.">JobSystem::DestroyBarrier</a> instead of destructing this object directly.  <br /></td></tr>
<tr class="separator:aa7553c8c987ca8bb810c2715ef8ffbbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab76635eef3bb293a2bceb429192adb2a" id="r_ab76635eef3bb293a2bceb429192adb2a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab76635eef3bb293a2bceb429192adb2a">OnJobFinished</a> (<a class="el" href="class_job_system_1_1_job.html">Job</a> *inJob)=0</td></tr>
<tr class="memdesc:ab76635eef3bb293a2bceb429192adb2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by a <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> to mark that it is finished.  <br /></td></tr>
<tr class="separator:ab76635eef3bb293a2bceb429192adb2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a965d805cf4fa6e7ef721cfad15d99bcd" id="r_a965d805cf4fa6e7ef721cfad15d99bcd"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a965d805cf4fa6e7ef721cfad15d99bcd">Job</a></td></tr>
<tr class="memdesc:a965d805cf4fa6e7ef721cfad15d99bcd"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> needs to be able to call OnJobFinished.  <br /></td></tr>
<tr class="separator:a965d805cf4fa6e7ef721cfad15d99bcd"><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 barrier keeps track of a number of jobs and allows waiting until they are all completed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa7553c8c987ca8bb810c2715ef8ffbbd" name="aa7553c8c987ca8bb810c2715ef8ffbbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7553c8c987ca8bb810c2715ef8ffbbd">&#9670;&#160;</a></span>~Barrier()</h2>

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

<p>Destructor, you should call <a class="el" href="class_job_system.html#a51c615924cf4f8eefb8e3fbe72041373" title="Destroy a barrier when it is no longer used. The barrier should be empty at this point.">JobSystem::DestroyBarrier</a> instead of destructing this object directly. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afcf8f345a7a19e1399c4899942ed49c4" name="afcf8f345a7a19e1399c4899942ed49c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcf8f345a7a19e1399c4899942ed49c4">&#9670;&#160;</a></span>AddJob()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> void JobSystem::Barrier::AddJob </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>inJob</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Add a job to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier </p>

<p>Implemented in <a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html#a777f9190686403c3a8d0796c0fe56077">JobSystemSingleThreaded::BarrierImpl</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void JobSystem::Barrier::AddJobs </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>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Add multiple jobs to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier </p>

<p>Implemented in <a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html#a124bc867efebec305deb57931370dc28">JobSystemSingleThreaded::BarrierImpl</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void JobSystem::Barrier::OnJobFinished </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">protected</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called by a <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> to mark that it is finished. </p>

<p>Implemented in <a class="el" href="class_job_system_single_threaded_1_1_barrier_impl.html#ad13990ca369c5cb94826dd026a447733">JobSystemSingleThreaded::BarrierImpl</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a965d805cf4fa6e7ef721cfad15d99bcd" name="a965d805cf4fa6e7ef721cfad15d99bcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a965d805cf4fa6e7ef721cfad15d99bcd">&#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">friend class <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">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><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> needs to be able to call OnJobFinished. </p>

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