_profiler_8h.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  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/Profiler.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('_profiler_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">Profiler.h File Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><code>#include &lt;mutex&gt;</code><br />
  113. <code>#include &lt;chrono&gt;</code><br />
  114. <code>#include &lt;<a class="el" href="_non_copyable_8h_source.html">Jolt/Core/NonCopyable.h</a>&gt;</code><br />
  115. <code>#include &lt;<a class="el" href="_tick_counter_8h_source.html">Jolt/Core/TickCounter.h</a>&gt;</code><br />
  116. <code>#include &lt;<a class="el" href="_unordered_map_8h_source.html">Jolt/Core/UnorderedMap.h</a>&gt;</code><br />
  117. <code>#include &quot;<a class="el" href="_profiler_8inl_source.html">Profiler.inl</a>&quot;</code><br />
  118. </div>
  119. <p><a href="_profiler_8h_source.html">Go to the source code of this file.</a></p>
  120. <table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  122. Classes</h2></td></tr>
  123. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_profiler.html">Profiler</a></td></tr>
  124. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Singleton class for managing profiling information. <a href="class_profiler.html#details">More...</a><br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_profile_sample.html">ProfileSample</a></td></tr>
  127. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_profile_thread.html">ProfileThread</a></td></tr>
  129. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collects all samples of a single thread. <a href="class_profile_thread.html#details">More...</a><br /></td></tr>
  130. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_profile_measurement.html">ProfileMeasurement</a></td></tr>
  132. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create this class on the stack to start sampling timing information of a particular scope. <a href="class_profile_measurement.html#details">More...</a><br /></td></tr>
  133. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  136. Macros</h2></td></tr>
  137. <tr class="memitem:a565915a1416629f5e8fd84ab2cbe7a14" id="r_a565915a1416629f5e8fd84ab2cbe7a14"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a565915a1416629f5e8fd84ab2cbe7a14">JPH_PROFILE_START</a>(name)</td></tr>
  138. <tr class="memdesc:a565915a1416629f5e8fd84ab2cbe7a14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start instrumenting program. <br /></td></tr>
  139. <tr class="separator:a565915a1416629f5e8fd84ab2cbe7a14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ad4065f7f547ab9ee221c76b6dc313425" id="r_ad4065f7f547ab9ee221c76b6dc313425"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4065f7f547ab9ee221c76b6dc313425">JPH_PROFILE_END</a>()</td></tr>
  141. <tr class="memdesc:ad4065f7f547ab9ee221c76b6dc313425"><td class="mdescLeft">&#160;</td><td class="mdescRight">End instrumenting program. <br /></td></tr>
  142. <tr class="separator:ad4065f7f547ab9ee221c76b6dc313425"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a5455272d603b90d629b74c0d64338173" id="r_a5455272d603b90d629b74c0d64338173"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5455272d603b90d629b74c0d64338173">JPH_PROFILE_THREAD_START</a>(name)</td></tr>
  144. <tr class="memdesc:a5455272d603b90d629b74c0d64338173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start instrumenting a thread. <br /></td></tr>
  145. <tr class="separator:a5455272d603b90d629b74c0d64338173"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:acdb6d6bc05aad36435219ee5f631efc8" id="r_acdb6d6bc05aad36435219ee5f631efc8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acdb6d6bc05aad36435219ee5f631efc8">JPH_PROFILE_THREAD_END</a>()</td></tr>
  147. <tr class="memdesc:acdb6d6bc05aad36435219ee5f631efc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">End instrumenting a thread. <br /></td></tr>
  148. <tr class="separator:acdb6d6bc05aad36435219ee5f631efc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a25c67544eb8ec8c174946341070a4ec0" id="r_a25c67544eb8ec8c174946341070a4ec0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25c67544eb8ec8c174946341070a4ec0">JPH_PROFILE_TAG2</a>(line)</td></tr>
  150. <tr class="memdesc:a25c67544eb8ec8c174946341070a4ec0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scope profiling measurement. <br /></td></tr>
  151. <tr class="separator:a25c67544eb8ec8c174946341070a4ec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ad70c118d5a68a0e7996f9e9e4bb04af8" id="r_ad70c118d5a68a0e7996f9e9e4bb04af8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad70c118d5a68a0e7996f9e9e4bb04af8">JPH_PROFILE_TAG</a>(line)</td></tr>
  153. <tr class="separator:ad70c118d5a68a0e7996f9e9e4bb04af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aeea975f69380f934d24a9169e43bac9b" id="r_aeea975f69380f934d24a9169e43bac9b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeea975f69380f934d24a9169e43bac9b">JPH_PROFILE</a>(...)</td></tr>
  155. <tr class="separator:aeea975f69380f934d24a9169e43bac9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a9d22d20c7f03e2ec7bf058811b12cb4e" id="r_a9d22d20c7f03e2ec7bf058811b12cb4e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d22d20c7f03e2ec7bf058811b12cb4e">JPH_PROFILE_FUNCTION</a>()</td></tr>
  157. <tr class="memdesc:a9d22d20c7f03e2ec7bf058811b12cb4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scope profiling for function. <br /></td></tr>
  158. <tr class="separator:a9d22d20c7f03e2ec7bf058811b12cb4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ac158343dbc5927ea288d3ef011feb288" id="r_ac158343dbc5927ea288d3ef011feb288"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac158343dbc5927ea288d3ef011feb288">JPH_PROFILE_NEXTFRAME</a>()</td></tr>
  160. <tr class="memdesc:ac158343dbc5927ea288d3ef011feb288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update frame counter. <br /></td></tr>
  161. <tr class="separator:ac158343dbc5927ea288d3ef011feb288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a7fd763325a27ec4b58e54119dbf08acb" id="r_a7fd763325a27ec4b58e54119dbf08acb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7fd763325a27ec4b58e54119dbf08acb">JPH_PROFILE_DUMP</a>(...)</td></tr>
  163. <tr class="memdesc:a7fd763325a27ec4b58e54119dbf08acb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump profiling info. <br /></td></tr>
  164. <tr class="separator:a7fd763325a27ec4b58e54119dbf08acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. </table>
  166. <h2 class="groupheader">Macro Definition Documentation</h2>
  167. <a id="aeea975f69380f934d24a9169e43bac9b" name="aeea975f69380f934d24a9169e43bac9b"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#aeea975f69380f934d24a9169e43bac9b">&#9670;&#160;</a></span>JPH_PROFILE</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">#define JPH_PROFILE</td>
  174. <td>(</td>
  175. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...</td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_class" href="class_profile_measurement.html">ProfileMeasurement</a> <a class="code hl_define" href="#ad70c118d5a68a0e7996f9e9e4bb04af8">JPH_PROFILE_TAG</a>(__LINE__)(__VA_ARGS__)</div>
  181. <div class="ttc" id="a_profiler_8h_html_ad70c118d5a68a0e7996f9e9e4bb04af8"><div class="ttname"><a href="#ad70c118d5a68a0e7996f9e9e4bb04af8">JPH_PROFILE_TAG</a></div><div class="ttdeci">#define JPH_PROFILE_TAG(line)</div><div class="ttdef"><b>Definition</b> Profiler.h:267</div></div>
  182. <div class="ttc" id="aclass_profile_measurement_html"><div class="ttname"><a href="class_profile_measurement.html">ProfileMeasurement</a></div><div class="ttdoc">Create this class on the stack to start sampling timing information of a particular scope.</div><div class="ttdef"><b>Definition</b> Profiler.h:229</div></div>
  183. </div><!-- fragment -->
  184. </div>
  185. </div>
  186. <a id="a7fd763325a27ec4b58e54119dbf08acb" name="a7fd763325a27ec4b58e54119dbf08acb"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#a7fd763325a27ec4b58e54119dbf08acb">&#9670;&#160;</a></span>JPH_PROFILE_DUMP</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">#define JPH_PROFILE_DUMP</td>
  193. <td>(</td>
  194. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...</td><td>)</td>
  195. <td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a>-&gt;<a class="code hl_function" href="class_profiler.html#a4a8f82d68bd5c67cf7ad8259487bb821">Dump</a>(__VA_ARGS__)</div>
  200. <div class="ttc" id="aclass_profiler_html_a4a8f82d68bd5c67cf7ad8259487bb821"><div class="ttname"><a href="class_profiler.html#a4a8f82d68bd5c67cf7ad8259487bb821">Profiler::Dump</a></div><div class="ttdeci">void Dump(const string_view &amp;inTag=string_view())</div><div class="ttdef"><b>Definition</b> Profiler.cpp:82</div></div>
  201. <div class="ttc" id="aclass_profiler_html_a804901c292686e870e221a0fa0621dbe"><div class="ttname"><a href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a></div><div class="ttdeci">static Profiler * sInstance</div><div class="ttdoc">Singleton instance.</div><div class="ttdef"><b>Definition</b> Profiler.h:120</div></div>
  202. </div><!-- fragment -->
  203. <p>Dump profiling info. </p>
  204. </div>
  205. </div>
  206. <a id="ad4065f7f547ab9ee221c76b6dc313425" name="ad4065f7f547ab9ee221c76b6dc313425"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#ad4065f7f547ab9ee221c76b6dc313425">&#9670;&#160;</a></span>JPH_PROFILE_END</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">#define JPH_PROFILE_END</td>
  213. <td>(</td>
  214. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <a class="code hl_define" href="#acdb6d6bc05aad36435219ee5f631efc8">JPH_PROFILE_THREAD_END</a>(); <span class="keyword">delete</span> <a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a>; <a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a> = <span class="keyword">nullptr</span>; } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
  220. <div class="ttc" id="a_profiler_8h_html_acdb6d6bc05aad36435219ee5f631efc8"><div class="ttname"><a href="#acdb6d6bc05aad36435219ee5f631efc8">JPH_PROFILE_THREAD_END</a></div><div class="ttdeci">#define JPH_PROFILE_THREAD_END()</div><div class="ttdoc">End instrumenting a thread.</div><div class="ttdef"><b>Definition</b> Profiler.h:263</div></div>
  221. </div><!-- fragment -->
  222. <p>End instrumenting program. </p>
  223. </div>
  224. </div>
  225. <a id="a9d22d20c7f03e2ec7bf058811b12cb4e" name="a9d22d20c7f03e2ec7bf058811b12cb4e"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a9d22d20c7f03e2ec7bf058811b12cb4e">&#9670;&#160;</a></span>JPH_PROFILE_FUNCTION</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">#define JPH_PROFILE_FUNCTION</td>
  232. <td>(</td>
  233. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  234. <td></td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#aeea975f69380f934d24a9169e43bac9b">JPH_PROFILE</a>(JPH_FUNCTION_NAME)</div>
  239. <div class="ttc" id="a_profiler_8h_html_aeea975f69380f934d24a9169e43bac9b"><div class="ttname"><a href="#aeea975f69380f934d24a9169e43bac9b">JPH_PROFILE</a></div><div class="ttdeci">#define JPH_PROFILE(...)</div><div class="ttdef"><b>Definition</b> Profiler.h:268</div></div>
  240. </div><!-- fragment -->
  241. <p>Scope profiling for function. </p>
  242. </div>
  243. </div>
  244. <a id="ac158343dbc5927ea288d3ef011feb288" name="ac158343dbc5927ea288d3ef011feb288"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#ac158343dbc5927ea288d3ef011feb288">&#9670;&#160;</a></span>JPH_PROFILE_NEXTFRAME</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">#define JPH_PROFILE_NEXTFRAME</td>
  251. <td>(</td>
  252. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a>-&gt;<a class="code hl_function" href="class_profiler.html#af2bab5342d06444376cd103c2c4207b8">NextFrame</a>()</div>
  258. <div class="ttc" id="aclass_profiler_html_af2bab5342d06444376cd103c2c4207b8"><div class="ttname"><a href="class_profiler.html#af2bab5342d06444376cd103c2c4207b8">Profiler::NextFrame</a></div><div class="ttdeci">void NextFrame()</div><div class="ttdoc">Increments the frame counter to provide statistics per frame.</div><div class="ttdef"><b>Definition</b> Profiler.cpp:66</div></div>
  259. </div><!-- fragment -->
  260. <p>Update frame counter. </p>
  261. </div>
  262. </div>
  263. <a id="a565915a1416629f5e8fd84ab2cbe7a14" name="a565915a1416629f5e8fd84ab2cbe7a14"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a565915a1416629f5e8fd84ab2cbe7a14">&#9670;&#160;</a></span>JPH_PROFILE_START</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">#define JPH_PROFILE_START</td>
  270. <td>(</td>
  271. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a> = <span class="keyword">new</span> <a class="code hl_class" href="class_profiler.html">Profiler</a>; <a class="code hl_define" href="#a5455272d603b90d629b74c0d64338173">JPH_PROFILE_THREAD_START</a>(name); } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
  277. <div class="ttc" id="a_profiler_8h_html_a5455272d603b90d629b74c0d64338173"><div class="ttname"><a href="#a5455272d603b90d629b74c0d64338173">JPH_PROFILE_THREAD_START</a></div><div class="ttdeci">#define JPH_PROFILE_THREAD_START(name)</div><div class="ttdoc">Start instrumenting a thread.</div><div class="ttdef"><b>Definition</b> Profiler.h:260</div></div>
  278. <div class="ttc" id="aclass_profiler_html"><div class="ttname"><a href="class_profiler.html">Profiler</a></div><div class="ttdoc">Singleton class for managing profiling information.</div><div class="ttdef"><b>Definition</b> Profiler.h:96</div></div>
  279. </div><!-- fragment -->
  280. <p>Start instrumenting program. </p>
  281. </div>
  282. </div>
  283. <a id="ad70c118d5a68a0e7996f9e9e4bb04af8" name="ad70c118d5a68a0e7996f9e9e4bb04af8"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#ad70c118d5a68a0e7996f9e9e4bb04af8">&#9670;&#160;</a></span>JPH_PROFILE_TAG</h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">#define JPH_PROFILE_TAG</td>
  290. <td>(</td>
  291. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>line</em></span></td><td>)</td>
  292. <td></td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a25c67544eb8ec8c174946341070a4ec0">JPH_PROFILE_TAG2</a>(line)</div>
  297. <div class="ttc" id="a_profiler_8h_html_a25c67544eb8ec8c174946341070a4ec0"><div class="ttname"><a href="#a25c67544eb8ec8c174946341070a4ec0">JPH_PROFILE_TAG2</a></div><div class="ttdeci">#define JPH_PROFILE_TAG2(line)</div><div class="ttdoc">Scope profiling measurement.</div><div class="ttdef"><b>Definition</b> Profiler.h:266</div></div>
  298. </div><!-- fragment -->
  299. </div>
  300. </div>
  301. <a id="a25c67544eb8ec8c174946341070a4ec0" name="a25c67544eb8ec8c174946341070a4ec0"></a>
  302. <h2 class="memtitle"><span class="permalink"><a href="#a25c67544eb8ec8c174946341070a4ec0">&#9670;&#160;</a></span>JPH_PROFILE_TAG2</h2>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">#define JPH_PROFILE_TAG2</td>
  308. <td>(</td>
  309. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>line</em></span></td><td>)</td>
  310. <td></td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <b>Value:</b><div class="fragment"><div class="line">profile##line</div>
  315. </div><!-- fragment -->
  316. <p>Scope profiling measurement. </p>
  317. </div>
  318. </div>
  319. <a id="acdb6d6bc05aad36435219ee5f631efc8" name="acdb6d6bc05aad36435219ee5f631efc8"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#acdb6d6bc05aad36435219ee5f631efc8">&#9670;&#160;</a></span>JPH_PROFILE_THREAD_END</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">#define JPH_PROFILE_THREAD_END</td>
  326. <td>(</td>
  327. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <span class="keyword">delete</span> <a class="code hl_function" href="class_profile_thread.html#a90519c92e016925589a4866b3dc916b7">ProfileThread::sGetInstance</a>(); <a class="code hl_function" href="class_profile_thread.html#ad957acc068d3fd9af54ba3d3e6f80d8f">ProfileThread::sSetInstance</a>(<span class="keyword">nullptr</span>); } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
  333. <div class="ttc" id="aclass_profile_thread_html_a90519c92e016925589a4866b3dc916b7"><div class="ttname"><a href="class_profile_thread.html#a90519c92e016925589a4866b3dc916b7">ProfileThread::sGetInstance</a></div><div class="ttdeci">static ProfileThread * sGetInstance()</div><div class="ttdef"><b>Definition</b> Profiler.h:220</div></div>
  334. <div class="ttc" id="aclass_profile_thread_html_ad957acc068d3fd9af54ba3d3e6f80d8f"><div class="ttname"><a href="class_profile_thread.html#ad957acc068d3fd9af54ba3d3e6f80d8f">ProfileThread::sSetInstance</a></div><div class="ttdeci">static void sSetInstance(ProfileThread *inInstance)</div><div class="ttdef"><b>Definition</b> Profiler.h:219</div></div>
  335. </div><!-- fragment -->
  336. <p>End instrumenting a thread. </p>
  337. </div>
  338. </div>
  339. <a id="a5455272d603b90d629b74c0d64338173" name="a5455272d603b90d629b74c0d64338173"></a>
  340. <h2 class="memtitle"><span class="permalink"><a href="#a5455272d603b90d629b74c0d64338173">&#9670;&#160;</a></span>JPH_PROFILE_THREAD_START</h2>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">#define JPH_PROFILE_THREAD_START</td>
  346. <td>(</td>
  347. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
  348. <td></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <span class="keywordflow">if</span> (<a class="code hl_variable" href="class_profiler.html#a804901c292686e870e221a0fa0621dbe">Profiler::sInstance</a>) <a class="code hl_function" href="class_profile_thread.html#ad957acc068d3fd9af54ba3d3e6f80d8f">ProfileThread::sSetInstance</a>(<span class="keyword">new</span> <a class="code hl_class" href="class_profile_thread.html">ProfileThread</a>(name)); } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
  353. <div class="ttc" id="aclass_profile_thread_html"><div class="ttname"><a href="class_profile_thread.html">ProfileThread</a></div><div class="ttdoc">Collects all samples of a single thread.</div><div class="ttdef"><b>Definition</b> Profiler.h:201</div></div>
  354. </div><!-- fragment -->
  355. <p>Start instrumenting a thread. </p>
  356. </div>
  357. </div>
  358. </div><!-- contents -->
  359. </div><!-- doc-content -->
  360. <!-- start footer part -->
  361. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  362. <ul>
  363. <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="_profiler_8h.html">Profiler.h</a></li>
  364. <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>
  365. </ul>
  366. </div>
  367. </body>
  368. </html>