| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477 |
- <!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: MutexArray< MutexType > Class Template 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&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
- $(function(){initNavTree('class_mutex_array.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> |
- <a href="class_mutex_array-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">MutexArray< MutexType > Class Template Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <<a class="el" href="_mutex_array_8h_source.html">MutexArray.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for MutexArray< MutexType >:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_mutex_array.png" usemap="#MutexArray_3C_20MutexType_20_3E_map" alt=""/>
- <map id="MutexArray_3C_20MutexType_20_3E_map" name="MutexArray_3C_20MutexType_20_3E_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,165,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:a7440b62f6b4d1a8bfd608f88a26299e8" id="r_a7440b62f6b4d1a8bfd608f88a26299e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7440b62f6b4d1a8bfd608f88a26299e8">MutexArray</a> ()=default</td></tr>
- <tr class="memdesc:a7440b62f6b4d1a8bfd608f88a26299e8"><td class="mdescLeft"> </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>
- <tr class="separator:a7440b62f6b4d1a8bfd608f88a26299e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a04bd4348871aea46fe2d567e5fa83861" id="r_a04bd4348871aea46fe2d567e5fa83861"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a04bd4348871aea46fe2d567e5fa83861"><td class="mdescLeft"> </td><td class="mdescRight">Constructor, constructs an array with inNumMutexes entries. <br /></td></tr>
- <tr class="separator:a04bd4348871aea46fe2d567e5fa83861"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a15da55df0a388b4cbdabdedefb425af0" id="r_a15da55df0a388b4cbdabdedefb425af0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a15da55df0a388b4cbdabdedefb425af0">~MutexArray</a> ()</td></tr>
- <tr class="memdesc:a15da55df0a388b4cbdabdedefb425af0"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:a15da55df0a388b4cbdabdedefb425af0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a882ec12f80ee295c78857d266cb69340" id="r_a882ec12f80ee295c78857d266cb69340"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a882ec12f80ee295c78857d266cb69340"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa901f85cfe3dff0c32edc0d8a852813" id="r_afa901f85cfe3dff0c32edc0d8a852813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afa901f85cfe3dff0c32edc0d8a852813">GetNumMutexes</a> () const</td></tr>
- <tr class="memdesc:afa901f85cfe3dff0c32edc0d8a852813"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of mutexes that were allocated. <br /></td></tr>
- <tr class="separator:afa901f85cfe3dff0c32edc0d8a852813"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a149c27328334bbe38b64230f2a5251f8" id="r_a149c27328334bbe38b64230f2a5251f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </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>
- <tr class="memdesc:a149c27328334bbe38b64230f2a5251f8"><td class="mdescLeft"> </td><td class="mdescRight">Convert an object index to a mutex index. <br /></td></tr>
- <tr class="separator:a149c27328334bbe38b64230f2a5251f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39bf8c118d368c256e5a5c09b39a42be" id="r_a39bf8c118d368c256e5a5c09b39a42be"><td class="memItemLeft" align="right" valign="top">MutexType & </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>
- <tr class="memdesc:a39bf8c118d368c256e5a5c09b39a42be"><td class="mdescLeft"> </td><td class="mdescRight">Get the mutex belonging to a certain object by index. <br /></td></tr>
- <tr class="separator:a39bf8c118d368c256e5a5c09b39a42be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab1837f7f0a9b0ce63ccbf6d34ca26058" id="r_ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="memItemLeft" align="right" valign="top">MutexType & </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>
- <tr class="memdesc:ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="mdescLeft"> </td><td class="mdescRight">Get a mutex by index in the array. <br /></td></tr>
- <tr class="separator:ab1837f7f0a9b0ce63ccbf6d34ca26058"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6b7192bee3d37aa5fcc12074081a66a6" id="r_a6b7192bee3d37aa5fcc12074081a66a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b7192bee3d37aa5fcc12074081a66a6">LockAll</a> ()</td></tr>
- <tr class="memdesc:a6b7192bee3d37aa5fcc12074081a66a6"><td class="mdescLeft"> </td><td class="mdescRight">Lock all mutexes. <br /></td></tr>
- <tr class="separator:a6b7192bee3d37aa5fcc12074081a66a6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a454120af29f8004e1dd3a81ea110d5b1" id="r_a454120af29f8004e1dd3a81ea110d5b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a454120af29f8004e1dd3a81ea110d5b1">UnlockAll</a> ()</td></tr>
- <tr class="memdesc:a454120af29f8004e1dd3a81ea110d5b1"><td class="mdescLeft"> </td><td class="mdescRight">Unlock all mutexes. <br /></td></tr>
- <tr class="separator:a454120af29f8004e1dd3a81ea110d5b1"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </td></tr>
- <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
- <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void </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> &)=delete</td></tr>
- <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><div class="compoundTemplParams">template<class MutexType><br />
- class MutexArray< MutexType ></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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a7440b62f6b4d1a8bfd608f88a26299e8" name="a7440b62f6b4d1a8bfd608f88a26299e8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7440b62f6b4d1a8bfd608f88a26299e8">◆ </a></span>MutexArray() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType ><a class="el" href="class_mutex_array.html">::MutexArray</a> </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">default</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor, constructs an empty mutex array that you need to initialize with <a class="el" href="#a882ec12f80ee295c78857d266cb69340">Init()</a> </p>
- </div>
- </div>
- <a id="a04bd4348871aea46fe2d567e5fa83861" name="a04bd4348871aea46fe2d567e5fa83861"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a04bd4348871aea46fe2d567e5fa83861">◆ </a></span>MutexArray() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType ><a class="el" href="class_mutex_array.html">::MutexArray</a> </td>
- <td>(</td>
- <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>
- <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, constructs an array with inNumMutexes entries. </p>
- </div>
- </div>
- <a id="a15da55df0a388b4cbdabdedefb425af0" name="a15da55df0a388b4cbdabdedefb425af0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a15da55df0a388b4cbdabdedefb425af0">◆ </a></span>~MutexArray()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::~<a class="el" href="class_mutex_array.html">MutexArray</a> </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>Destructor. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ab1837f7f0a9b0ce63ccbf6d34ca26058" name="ab1837f7f0a9b0ce63ccbf6d34ca26058"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab1837f7f0a9b0ce63ccbf6d34ca26058">◆ </a></span>GetMutexByIndex()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MutexType & <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::GetMutexByIndex </td>
- <td>(</td>
- <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>
- <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 a mutex by index in the array. </p>
- </div>
- </div>
- <a id="a39bf8c118d368c256e5a5c09b39a42be" name="a39bf8c118d368c256e5a5c09b39a42be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a39bf8c118d368c256e5a5c09b39a42be">◆ </a></span>GetMutexByObjectIndex()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MutexType & <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::GetMutexByObjectIndex </td>
- <td>(</td>
- <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>
- <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 mutex belonging to a certain object by index. </p>
- </div>
- </div>
- <a id="a149c27328334bbe38b64230f2a5251f8" name="a149c27328334bbe38b64230f2a5251f8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a149c27328334bbe38b64230f2a5251f8">◆ </a></span>GetMutexIndex()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <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> <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::GetMutexIndex </td>
- <td>(</td>
- <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>
- <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>Convert an object index to a mutex index. </p>
- </div>
- </div>
- <a id="afa901f85cfe3dff0c32edc0d8a852813" name="afa901f85cfe3dff0c32edc0d8a852813"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afa901f85cfe3dff0c32edc0d8a852813">◆ </a></span>GetNumMutexes()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::GetNumMutexes </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 number of mutexes that were allocated. </p>
- </div>
- </div>
- <a id="a882ec12f80ee295c78857d266cb69340" name="a882ec12f80ee295c78857d266cb69340"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a882ec12f80ee295c78857d266cb69340">◆ </a></span>Init()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::Init </td>
- <td>(</td>
- <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>
- <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>Initialization </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inNumMutexes</td><td>The amount of mutexes to allocate </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a6b7192bee3d37aa5fcc12074081a66a6" name="a6b7192bee3d37aa5fcc12074081a66a6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6b7192bee3d37aa5fcc12074081a66a6">◆ </a></span>LockAll()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::LockAll </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>Lock all mutexes. </p>
- </div>
- </div>
- <a id="a454120af29f8004e1dd3a81ea110d5b1" name="a454120af29f8004e1dd3a81ea110d5b1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a454120af29f8004e1dd3a81ea110d5b1">◆ </a></span>UnlockAll()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class MutexType > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="class_mutex_array.html">MutexArray</a>< MutexType >::UnlockAll </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>Unlock all mutexes. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>Jolt/Core/<a class="el" href="_mutex_array_8h_source.html">MutexArray.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_mutex_array.html">MutexArray</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>
|