class_mutex_array.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: MutexArray&lt; MutexType &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_mutex_array.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="class_mutex_array-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">MutexArray&lt; MutexType &gt; Class Template Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_mutex_array_8h_source.html">MutexArray.h</a>&gt;</code></p>
  113. <div class="dynheader">
  114. Inheritance diagram for MutexArray&lt; MutexType &gt;:</div>
  115. <div class="dyncontent">
  116. <div class="center">
  117. <img src="class_mutex_array.png" usemap="#MutexArray_3C_20MutexType_20_3E_map" alt=""/>
  118. <map id="MutexArray_3C_20MutexType_20_3E_map" name="MutexArray_3C_20MutexType_20_3E_map">
  119. <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,165,24"/>
  120. </map>
  121. </div></div>
  122. <table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  124. Public Member Functions</h2></td></tr>
  125. <tr class="memitem:a7440b62f6b4d1a8bfd608f88a26299e8" id="r_a7440b62f6b4d1a8bfd608f88a26299e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7440b62f6b4d1a8bfd608f88a26299e8">MutexArray</a> ()=default</td></tr>
  126. <tr class="memdesc:a7440b62f6b4d1a8bfd608f88a26299e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, constructs an empty mutex array that you need to initialize with <a class="el" href="#a882ec12f80ee295c78857d266cb69340">Init()</a> <br /></td></tr>
  127. <tr class="separator:a7440b62f6b4d1a8bfd608f88a26299e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a04bd4348871aea46fe2d567e5fa83861" id="r_a04bd4348871aea46fe2d567e5fa83861"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a04bd4348871aea46fe2d567e5fa83861">MutexArray</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumMutexes)</td></tr>
  129. <tr class="memdesc:a04bd4348871aea46fe2d567e5fa83861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, constructs an array with inNumMutexes entries. <br /></td></tr>
  130. <tr class="separator:a04bd4348871aea46fe2d567e5fa83861"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a15da55df0a388b4cbdabdedefb425af0" id="r_a15da55df0a388b4cbdabdedefb425af0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a15da55df0a388b4cbdabdedefb425af0">~MutexArray</a> ()</td></tr>
  132. <tr class="memdesc:a15da55df0a388b4cbdabdedefb425af0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  133. <tr class="separator:a15da55df0a388b4cbdabdedefb425af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a882ec12f80ee295c78857d266cb69340" id="r_a882ec12f80ee295c78857d266cb69340"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a882ec12f80ee295c78857d266cb69340">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumMutexes)</td></tr>
  135. <tr class="separator:a882ec12f80ee295c78857d266cb69340"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:afa901f85cfe3dff0c32edc0d8a852813" id="r_afa901f85cfe3dff0c32edc0d8a852813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa901f85cfe3dff0c32edc0d8a852813">GetNumMutexes</a> () const</td></tr>
  137. <tr class="memdesc:afa901f85cfe3dff0c32edc0d8a852813"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of mutexes that were allocated. <br /></td></tr>
  138. <tr class="separator:afa901f85cfe3dff0c32edc0d8a852813"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a149c27328334bbe38b64230f2a5251f8" id="r_a149c27328334bbe38b64230f2a5251f8"><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="#a149c27328334bbe38b64230f2a5251f8">GetMutexIndex</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex) const</td></tr>
  140. <tr class="memdesc:a149c27328334bbe38b64230f2a5251f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert an object index to a mutex index. <br /></td></tr>
  141. <tr class="separator:a149c27328334bbe38b64230f2a5251f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a39bf8c118d368c256e5a5c09b39a42be" id="r_a39bf8c118d368c256e5a5c09b39a42be"><td class="memItemLeft" align="right" valign="top">MutexType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a39bf8c118d368c256e5a5c09b39a42be">GetMutexByObjectIndex</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inObjectIndex)</td></tr>
  143. <tr class="memdesc:a39bf8c118d368c256e5a5c09b39a42be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mutex belonging to a certain object by index. <br /></td></tr>
  144. <tr class="separator:a39bf8c118d368c256e5a5c09b39a42be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ab1837f7f0a9b0ce63ccbf6d34ca26058" id="r_ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="memItemLeft" align="right" valign="top">MutexType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1837f7f0a9b0ce63ccbf6d34ca26058">GetMutexByIndex</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inMutexIndex)</td></tr>
  146. <tr class="memdesc:ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a mutex by index in the array. <br /></td></tr>
  147. <tr class="separator:ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a6b7192bee3d37aa5fcc12074081a66a6" id="r_a6b7192bee3d37aa5fcc12074081a66a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b7192bee3d37aa5fcc12074081a66a6">LockAll</a> ()</td></tr>
  149. <tr class="memdesc:a6b7192bee3d37aa5fcc12074081a66a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock all mutexes. <br /></td></tr>
  150. <tr class="separator:a6b7192bee3d37aa5fcc12074081a66a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a454120af29f8004e1dd3a81ea110d5b1" id="r_a454120af29f8004e1dd3a81ea110d5b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a454120af29f8004e1dd3a81ea110d5b1">UnlockAll</a> ()</td></tr>
  152. <tr class="memdesc:a454120af29f8004e1dd3a81ea110d5b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlock all mutexes. <br /></td></tr>
  153. <tr class="separator:a454120af29f8004e1dd3a81ea110d5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <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>
  156. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <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>
  158. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <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>
  160. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table>
  162. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  163. <div class="textblock"><div class="compoundTemplParams">template&lt;class MutexType&gt;<br />
  164. class MutexArray&lt; MutexType &gt;</div><p>A mutex array protects a number of resources with a limited amount of mutexes. It uses hashing to find the mutex of a particular object. The idea is that if the amount of threads is much smaller than the amount of mutexes that there is a relatively small chance that two different objects map to the same mutex. </p>
  165. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  166. <a id="a7440b62f6b4d1a8bfd608f88a26299e8" name="a7440b62f6b4d1a8bfd608f88a26299e8"></a>
  167. <h2 class="memtitle"><span class="permalink"><a href="#a7440b62f6b4d1a8bfd608f88a26299e8">&#9670;&#160;</a></span>MutexArray() <span class="overload">[1/2]</span></h2>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <div class="memtemplate">
  171. template&lt;class MutexType &gt; </div>
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;<a class="el" href="class_mutex_array.html">::MutexArray</a> </td>
  178. <td>(</td>
  179. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </td>
  184. <td class="mlabels-right">
  185. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Constructor, constructs an empty mutex array that you need to initialize with <a class="el" href="#a882ec12f80ee295c78857d266cb69340">Init()</a> </p>
  190. </div>
  191. </div>
  192. <a id="a04bd4348871aea46fe2d567e5fa83861" name="a04bd4348871aea46fe2d567e5fa83861"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a04bd4348871aea46fe2d567e5fa83861">&#9670;&#160;</a></span>MutexArray() <span class="overload">[2/2]</span></h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <div class="memtemplate">
  197. template&lt;class MutexType &gt; </div>
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;<a class="el" href="class_mutex_array.html">::MutexArray</a> </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumMutexes</em></span></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </td>
  210. <td class="mlabels-right">
  211. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Constructor, constructs an array with inNumMutexes entries. </p>
  216. </div>
  217. </div>
  218. <a id="a15da55df0a388b4cbdabdedefb425af0" name="a15da55df0a388b4cbdabdedefb425af0"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a15da55df0a388b4cbdabdedefb425af0">&#9670;&#160;</a></span>~MutexArray()</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <div class="memtemplate">
  223. template&lt;class MutexType &gt; </div>
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::~<a class="el" href="class_mutex_array.html">MutexArray</a> </td>
  230. <td>(</td>
  231. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Destructor. </p>
  242. </div>
  243. </div>
  244. <h2 class="groupheader">Member Function Documentation</h2>
  245. <a id="ab1837f7f0a9b0ce63ccbf6d34ca26058" name="ab1837f7f0a9b0ce63ccbf6d34ca26058"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#ab1837f7f0a9b0ce63ccbf6d34ca26058">&#9670;&#160;</a></span>GetMutexByIndex()</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <div class="memtemplate">
  250. template&lt;class MutexType &gt; </div>
  251. <table class="mlabels">
  252. <tr>
  253. <td class="mlabels-left">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">MutexType &amp; <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::GetMutexByIndex </td>
  257. <td>(</td>
  258. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inMutexIndex</em></span></td><td>)</td>
  259. <td></td>
  260. </tr>
  261. </table>
  262. </td>
  263. <td class="mlabels-right">
  264. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Get a mutex by index in the array. </p>
  269. </div>
  270. </div>
  271. <a id="a39bf8c118d368c256e5a5c09b39a42be" name="a39bf8c118d368c256e5a5c09b39a42be"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a39bf8c118d368c256e5a5c09b39a42be">&#9670;&#160;</a></span>GetMutexByObjectIndex()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <div class="memtemplate">
  276. template&lt;class MutexType &gt; </div>
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">MutexType &amp; <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::GetMutexByObjectIndex </td>
  283. <td>(</td>
  284. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span></td><td>)</td>
  285. <td></td>
  286. </tr>
  287. </table>
  288. </td>
  289. <td class="mlabels-right">
  290. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Get the mutex belonging to a certain object by index. </p>
  295. </div>
  296. </div>
  297. <a id="a149c27328334bbe38b64230f2a5251f8" name="a149c27328334bbe38b64230f2a5251f8"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#a149c27328334bbe38b64230f2a5251f8">&#9670;&#160;</a></span>GetMutexIndex()</h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <div class="memtemplate">
  302. template&lt;class MutexType &gt; </div>
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::GetMutexIndex </td>
  309. <td>(</td>
  310. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inObjectIndex</em></span></td><td>)</td>
  311. <td> const</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Convert an object index to a mutex index. </p>
  321. </div>
  322. </div>
  323. <a id="afa901f85cfe3dff0c32edc0d8a852813" name="afa901f85cfe3dff0c32edc0d8a852813"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#afa901f85cfe3dff0c32edc0d8a852813">&#9670;&#160;</a></span>GetNumMutexes()</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <div class="memtemplate">
  328. template&lt;class MutexType &gt; </div>
  329. <table class="mlabels">
  330. <tr>
  331. <td class="mlabels-left">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::GetNumMutexes </td>
  335. <td>(</td>
  336. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  337. <td> const</td>
  338. </tr>
  339. </table>
  340. </td>
  341. <td class="mlabels-right">
  342. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Get the number of mutexes that were allocated. </p>
  347. </div>
  348. </div>
  349. <a id="a882ec12f80ee295c78857d266cb69340" name="a882ec12f80ee295c78857d266cb69340"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a882ec12f80ee295c78857d266cb69340">&#9670;&#160;</a></span>Init()</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <div class="memtemplate">
  354. template&lt;class MutexType &gt; </div>
  355. <table class="mlabels">
  356. <tr>
  357. <td class="mlabels-left">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::Init </td>
  361. <td>(</td>
  362. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumMutexes</em></span></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </td>
  367. <td class="mlabels-right">
  368. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <p>Initialization </p><dl class="params"><dt>Parameters</dt><dd>
  373. <table class="params">
  374. <tr><td class="paramname">inNumMutexes</td><td>The amount of mutexes to allocate </td></tr>
  375. </table>
  376. </dd>
  377. </dl>
  378. </div>
  379. </div>
  380. <a id="a6b7192bee3d37aa5fcc12074081a66a6" name="a6b7192bee3d37aa5fcc12074081a66a6"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#a6b7192bee3d37aa5fcc12074081a66a6">&#9670;&#160;</a></span>LockAll()</h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <div class="memtemplate">
  385. template&lt;class MutexType &gt; </div>
  386. <table class="mlabels">
  387. <tr>
  388. <td class="mlabels-left">
  389. <table class="memname">
  390. <tr>
  391. <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::LockAll </td>
  392. <td>(</td>
  393. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  394. <td></td>
  395. </tr>
  396. </table>
  397. </td>
  398. <td class="mlabels-right">
  399. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>Lock all mutexes. </p>
  404. </div>
  405. </div>
  406. <a id="a454120af29f8004e1dd3a81ea110d5b1" name="a454120af29f8004e1dd3a81ea110d5b1"></a>
  407. <h2 class="memtitle"><span class="permalink"><a href="#a454120af29f8004e1dd3a81ea110d5b1">&#9670;&#160;</a></span>UnlockAll()</h2>
  408. <div class="memitem">
  409. <div class="memproto">
  410. <div class="memtemplate">
  411. template&lt;class MutexType &gt; </div>
  412. <table class="mlabels">
  413. <tr>
  414. <td class="mlabels-left">
  415. <table class="memname">
  416. <tr>
  417. <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>&lt; MutexType &gt;::UnlockAll </td>
  418. <td>(</td>
  419. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  420. <td></td>
  421. </tr>
  422. </table>
  423. </td>
  424. <td class="mlabels-right">
  425. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Unlock all mutexes. </p>
  430. </div>
  431. </div>
  432. <hr/>The documentation for this class was generated from the following file:<ul>
  433. <li>Jolt/Core/<a class="el" href="_mutex_array_8h_source.html">MutexArray.h</a></li>
  434. </ul>
  435. </div><!-- contents -->
  436. </div><!-- doc-content -->
  437. <!-- start footer part -->
  438. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  439. <ul>
  440. <li class="navelem"><a class="el" href="class_mutex_array.html">MutexArray</a></li>
  441. <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>
  442. </ul>
  443. </div>
  444. </body>
  445. </html>