class_profile_sample.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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: ProfileSample Class 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_profile_sample.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-attribs">Public Attributes</a> &#124;
  108. <a href="class_profile_sample-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">ProfileSample Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_profiler_8h_source.html">Profiler.h</a>&gt;</code></p>
  113. <div class="dynheader">
  114. Inheritance diagram for ProfileSample:</div>
  115. <div class="dyncontent">
  116. <div class="center">
  117. <img src="class_profile_sample.png" usemap="#ProfileSample_map" alt=""/>
  118. <map id="ProfileSample_map" name="ProfileSample_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,90,24"/>
  120. </map>
  121. </div></div>
  122. <table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  124. Public Attributes</h2></td></tr>
  125. <tr class="memitem:abdc79744926fda6484f18e8bee225d1b" id="r_abdc79744926fda6484f18e8bee225d1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abdc79744926fda6484f18e8bee225d1b">mName</a></td></tr>
  126. <tr class="memdesc:abdc79744926fda6484f18e8bee225d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined name of this item. <br /></td></tr>
  127. <tr class="separator:abdc79744926fda6484f18e8bee225d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a02343312f37163bd02faf4f9751fe4a9" id="r_a02343312f37163bd02faf4f9751fe4a9"><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="#a02343312f37163bd02faf4f9751fe4a9">mColor</a></td></tr>
  129. <tr class="memdesc:a02343312f37163bd02faf4f9751fe4a9"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_color.html" title="Class that holds an RGBA color with 8-bits per component.">Color</a> to use for this sample. <br /></td></tr>
  130. <tr class="separator:a02343312f37163bd02faf4f9751fe4a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:add124282af00ea60608ac83c683787e2" id="r_add124282af00ea60608ac83c683787e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#add124282af00ea60608ac83c683787e2">mDepth</a></td></tr>
  132. <tr class="memdesc:add124282af00ea60608ac83c683787e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculated depth. <br /></td></tr>
  133. <tr class="separator:add124282af00ea60608ac83c683787e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a1be9087e2cefdd32f178ce64ea46c349" id="r_a1be9087e2cefdd32f178ce64ea46c349"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1be9087e2cefdd32f178ce64ea46c349">mUnused</a> [3]</td></tr>
  135. <tr class="separator:a1be9087e2cefdd32f178ce64ea46c349"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:ae91dc9a0769eb9f97e061682021adcc0" id="r_ae91dc9a0769eb9f97e061682021adcc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae91dc9a0769eb9f97e061682021adcc0">mStartCycle</a></td></tr>
  137. <tr class="memdesc:ae91dc9a0769eb9f97e061682021adcc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cycle counter at start of measurement. <br /></td></tr>
  138. <tr class="separator:ae91dc9a0769eb9f97e061682021adcc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a49970a1931c5764ce97d388ac4516113" id="r_a49970a1931c5764ce97d388ac4516113"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49970a1931c5764ce97d388ac4516113">mEndCycle</a></td></tr>
  140. <tr class="memdesc:a49970a1931c5764ce97d388ac4516113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cycle counter at end of measurement. <br /></td></tr>
  141. <tr class="separator:a49970a1931c5764ce97d388ac4516113"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  144. Additional Inherited Members</h2></td></tr>
  145. <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>
  146. <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>
  147. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <h2 class="groupheader">Member Data Documentation</h2>
  154. <a id="a02343312f37163bd02faf4f9751fe4a9" name="a02343312f37163bd02faf4f9751fe4a9"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a02343312f37163bd02faf4f9751fe4a9">&#9670;&#160;</a></span>mColor</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> ProfileSample::mColor</td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p><a class="el" href="class_color.html" title="Class that holds an RGBA color with 8-bits per component.">Color</a> to use for this sample. </p>
  165. </div>
  166. </div>
  167. <a id="add124282af00ea60608ac83c683787e2" name="add124282af00ea60608ac83c683787e2"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#add124282af00ea60608ac83c683787e2">&#9670;&#160;</a></span>mDepth</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a> ProfileSample::mDepth</td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Calculated depth. </p>
  178. </div>
  179. </div>
  180. <a id="a49970a1931c5764ce97d388ac4516113" name="a49970a1931c5764ce97d388ac4516113"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a49970a1931c5764ce97d388ac4516113">&#9670;&#160;</a></span>mEndCycle</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> ProfileSample::mEndCycle</td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Cycle counter at end of measurement. </p>
  191. </div>
  192. </div>
  193. <a id="abdc79744926fda6484f18e8bee225d1b" name="abdc79744926fda6484f18e8bee225d1b"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#abdc79744926fda6484f18e8bee225d1b">&#9670;&#160;</a></span>mName</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> const char* ProfileSample::mName</td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>User defined name of this item. </p>
  204. </div>
  205. </div>
  206. <a id="ae91dc9a0769eb9f97e061682021adcc0" name="ae91dc9a0769eb9f97e061682021adcc0"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#ae91dc9a0769eb9f97e061682021adcc0">&#9670;&#160;</a></span>mStartCycle</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> ProfileSample::mStartCycle</td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Cycle counter at start of measurement. </p>
  217. </div>
  218. </div>
  219. <a id="a1be9087e2cefdd32f178ce64ea46c349" name="a1be9087e2cefdd32f178ce64ea46c349"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#a1be9087e2cefdd32f178ce64ea46c349">&#9670;&#160;</a></span>mUnused</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a> ProfileSample::mUnused[3]</td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. </div>
  230. </div>
  231. <hr/>The documentation for this class was generated from the following file:<ul>
  232. <li>Jolt/Core/<a class="el" href="_profiler_8h_source.html">Profiler.h</a></li>
  233. </ul>
  234. </div><!-- contents -->
  235. </div><!-- doc-content -->
  236. <!-- start footer part -->
  237. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  238. <ul>
  239. <li class="navelem"><a class="el" href="class_profile_sample.html">ProfileSample</a></li>
  240. <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>
  241. </ul>
  242. </div>
  243. </body>
  244. </html>