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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
							<!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: PhysicsLock 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_physics_lock.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-static-methods">Static Public Member Functions</a> &#124;
<a href="class_physics_lock-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">PhysicsLock Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_physics_lock_8h_source.html">PhysicsLock.h</a>&gt;</code></p>
<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:ae103305ffa4e008ab2511866b88fc782" id="r_ae103305ffa4e008ab2511866b88fc782"><td class="memTemplParams" colspan="2">template&lt;class LockType &gt; </td></tr>
<tr class="memitem:ae103305ffa4e008ab2511866b88fc782"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae103305ffa4e008ab2511866b88fc782">sLock</a> (LockType &amp;inMutex <a class="el" href="_issue_reporting_8h.html#a9189784257d6995aa3ecbafbf8bc5bd5">JPH_IF_ENABLE_ASSERTS</a>(, PhysicsLockContext inContext, EPhysicsLockTypes inType))</td></tr>
<tr class="separator:ae103305ffa4e008ab2511866b88fc782"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93408c0ca5bd7bd4668c3c78dbf49966" id="r_a93408c0ca5bd7bd4668c3c78dbf49966"><td class="memTemplParams" colspan="2">template&lt;class LockType &gt; </td></tr>
<tr class="memitem:a93408c0ca5bd7bd4668c3c78dbf49966"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a93408c0ca5bd7bd4668c3c78dbf49966">sUnlock</a> (LockType &amp;inMutex <a class="el" href="_issue_reporting_8h.html#a9189784257d6995aa3ecbafbf8bc5bd5">JPH_IF_ENABLE_ASSERTS</a>(, PhysicsLockContext inContext, EPhysicsLockTypes inType))</td></tr>
<tr class="separator:a93408c0ca5bd7bd4668c3c78dbf49966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a625ab9c9ade9d679ea4b4fc9693f8f7d" id="r_a625ab9c9ade9d679ea4b4fc9693f8f7d"><td class="memTemplParams" colspan="2">template&lt;class LockType &gt; </td></tr>
<tr class="memitem:a625ab9c9ade9d679ea4b4fc9693f8f7d"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a625ab9c9ade9d679ea4b4fc9693f8f7d">sLockShared</a> (LockType &amp;inMutex <a class="el" href="_issue_reporting_8h.html#a9189784257d6995aa3ecbafbf8bc5bd5">JPH_IF_ENABLE_ASSERTS</a>(, PhysicsLockContext inContext, EPhysicsLockTypes inType))</td></tr>
<tr class="separator:a625ab9c9ade9d679ea4b4fc9693f8f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab42fb21e1412524a772aa26b9f7411b3" id="r_ab42fb21e1412524a772aa26b9f7411b3"><td class="memTemplParams" colspan="2">template&lt;class LockType &gt; </td></tr>
<tr class="memitem:ab42fb21e1412524a772aa26b9f7411b3"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab42fb21e1412524a772aa26b9f7411b3">sUnlockShared</a> (LockType &amp;inMutex <a class="el" href="_issue_reporting_8h.html#a9189784257d6995aa3ecbafbf8bc5bd5">JPH_IF_ENABLE_ASSERTS</a>(, PhysicsLockContext inContext, EPhysicsLockTypes inType))</td></tr>
<tr class="separator:ab42fb21e1412524a772aa26b9f7411b3"><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>Helpers to safely lock the different mutexes that are part of the physics system while preventing deadlock Class that keeps track per thread which lock are taken and if the order of locking is correct </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae103305ffa4e008ab2511866b88fc782" name="ae103305ffa4e008ab2511866b88fc782"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae103305ffa4e008ab2511866b88fc782">&#9670;&#160;</a></span>sLock()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class LockType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void PhysicsLock::sLock </td>
          <td>(</td>
          <td class="paramtype">LockType &amp;inMutex </td>          <td class="paramname"><span class="paramname"><em>JPH_IF_ENABLE_ASSERTS</em></span>, PhysicsLockContext inContext, EPhysicsLockTypes inType</td><td>)</td>
          <td></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">

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class LockType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void PhysicsLock::sLockShared </td>
          <td>(</td>
          <td class="paramtype">LockType &amp;inMutex </td>          <td class="paramname"><span class="paramname"><em>JPH_IF_ENABLE_ASSERTS</em></span>, PhysicsLockContext inContext, EPhysicsLockTypes inType</td><td>)</td>
          <td></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">

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class LockType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void PhysicsLock::sUnlock </td>
          <td>(</td>
          <td class="paramtype">LockType &amp;inMutex </td>          <td class="paramname"><span class="paramname"><em>JPH_IF_ENABLE_ASSERTS</em></span>, PhysicsLockContext inContext, EPhysicsLockTypes inType</td><td>)</td>
          <td></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">

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class LockType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void PhysicsLock::sUnlockShared </td>
          <td>(</td>
          <td class="paramtype">LockType &amp;inMutex </td>          <td class="paramname"><span class="paramname"><em>JPH_IF_ENABLE_ASSERTS</em></span>, PhysicsLockContext inContext, EPhysicsLockTypes inType</td><td>)</td>
          <td></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">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Physics/<a class="el" href="_physics_lock_8h_source.html">PhysicsLock.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_physics_lock.html">PhysicsLock</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>