_scope_exit_8h.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  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: Jolt/Core/ScopeExit.h File 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('_scope_exit_8h.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="#nested-classes">Classes</a> &#124;
  108. <a href="#define-members">Macros</a> </div>
  109. <div class="headertitle"><div class="title">ScopeExit.h File Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><code>#include &lt;<a class="el" href="_non_copyable_8h_source.html">Jolt/Core/NonCopyable.h</a>&gt;</code><br />
  113. </div>
  114. <p><a href="_scope_exit_8h_source.html">Go to the source code of this file.</a></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  117. Classes</h2></td></tr>
  118. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_scope_exit.html">ScopeExit&lt; F &gt;</a></td></tr>
  119. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that calls a function when it goes out of scope. <a href="class_scope_exit.html#details">More...</a><br /></td></tr>
  120. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  123. Macros</h2></td></tr>
  124. <tr class="memitem:af3b6234fdd42f0f27a584738fb79b60a" id="r_af3b6234fdd42f0f27a584738fb79b60a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3b6234fdd42f0f27a584738fb79b60a">JPH_SCOPE_EXIT_TAG2</a>(line)</td></tr>
  125. <tr class="separator:af3b6234fdd42f0f27a584738fb79b60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a34f8b40943318ef531e67cda41e687b9" id="r_a34f8b40943318ef531e67cda41e687b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34f8b40943318ef531e67cda41e687b9">JPH_SCOPE_EXIT_TAG</a>(line)</td></tr>
  127. <tr class="separator:a34f8b40943318ef531e67cda41e687b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a839a77790fe3ad876d339661b0dedc82" id="r_a839a77790fe3ad876d339661b0dedc82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a839a77790fe3ad876d339661b0dedc82">JPH_SCOPE_EXIT</a>(...)</td></tr>
  129. <tr class="memdesc:a839a77790fe3ad876d339661b0dedc82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Usage: JPH_SCOPE_EXIT([]{ code to call on scope exit });. <br /></td></tr>
  130. <tr class="separator:a839a77790fe3ad876d339661b0dedc82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <h2 class="groupheader">Macro Definition Documentation</h2>
  133. <a id="a839a77790fe3ad876d339661b0dedc82" name="a839a77790fe3ad876d339661b0dedc82"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#a839a77790fe3ad876d339661b0dedc82">&#9670;&#160;</a></span>JPH_SCOPE_EXIT</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">#define JPH_SCOPE_EXIT</td>
  140. <td>(</td>
  141. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...</td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_class" href="class_scope_exit.html">ScopeExit</a> <a class="code hl_define" href="#a34f8b40943318ef531e67cda41e687b9">JPH_SCOPE_EXIT_TAG</a>(__LINE__)(__VA_ARGS__)</div>
  147. <div class="ttc" id="a_scope_exit_8h_html_a34f8b40943318ef531e67cda41e687b9"><div class="ttname"><a href="#a34f8b40943318ef531e67cda41e687b9">JPH_SCOPE_EXIT_TAG</a></div><div class="ttdeci">#define JPH_SCOPE_EXIT_TAG(line)</div><div class="ttdef"><b>Definition</b> ScopeExit.h:44</div></div>
  148. <div class="ttc" id="aclass_scope_exit_html"><div class="ttname"><a href="class_scope_exit.html">ScopeExit</a></div><div class="ttdoc">Class that calls a function when it goes out of scope.</div><div class="ttdef"><b>Definition</b> ScopeExit.h:14</div></div>
  149. </div><!-- fragment -->
  150. <p>Usage: JPH_SCOPE_EXIT([]{ code to call on scope exit });. </p>
  151. </div>
  152. </div>
  153. <a id="a34f8b40943318ef531e67cda41e687b9" name="a34f8b40943318ef531e67cda41e687b9"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a34f8b40943318ef531e67cda41e687b9">&#9670;&#160;</a></span>JPH_SCOPE_EXIT_TAG</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">#define JPH_SCOPE_EXIT_TAG</td>
  160. <td>(</td>
  161. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>line</em></span></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#af3b6234fdd42f0f27a584738fb79b60a">JPH_SCOPE_EXIT_TAG2</a>(line)</div>
  167. <div class="ttc" id="a_scope_exit_8h_html_af3b6234fdd42f0f27a584738fb79b60a"><div class="ttname"><a href="#af3b6234fdd42f0f27a584738fb79b60a">JPH_SCOPE_EXIT_TAG2</a></div><div class="ttdeci">#define JPH_SCOPE_EXIT_TAG2(line)</div><div class="ttdef"><b>Definition</b> ScopeExit.h:43</div></div>
  168. </div><!-- fragment -->
  169. </div>
  170. </div>
  171. <a id="af3b6234fdd42f0f27a584738fb79b60a" name="af3b6234fdd42f0f27a584738fb79b60a"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#af3b6234fdd42f0f27a584738fb79b60a">&#9670;&#160;</a></span>JPH_SCOPE_EXIT_TAG2</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">#define JPH_SCOPE_EXIT_TAG2</td>
  178. <td>(</td>
  179. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>line</em></span></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <b>Value:</b><div class="fragment"><div class="line">scope_exit##line</div>
  185. </div><!-- fragment -->
  186. </div>
  187. </div>
  188. </div><!-- contents -->
  189. </div><!-- doc-content -->
  190. <!-- start footer part -->
  191. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  192. <ul>
  193. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_1b21a6f5692b6d84bf3b848a79181d46.html">Core</a></li><li class="navelem"><a class="el" href="_scope_exit_8h.html">ScopeExit.h</a></li>
  194. <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>
  195. </ul>
  196. </div>
  197. </body>
  198. </html>