md__docs_2_performance_test.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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: Performance Test</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('md__docs_2_performance_test.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><div class="header">
  106. <div class="headertitle"><div class="title">Performance Test</div></div>
  107. </div><!--header-->
  108. <div class="contents">
  109. <div class="textblock"><p><a class="anchor" id="autotoc_md1"></a></p>
  110. <p>The performance test application contains a couple of simple scenes to test performance of Jolt Physics. It will output the results to the TTY in CSV format.</p>
  111. <h1><a class="anchor" id="autotoc_md2"></a>
  112. Commandline options</h1>
  113. <ul>
  114. <li>-s=[scene]: This allows you to select a scene, [scene] can be;<ul>
  115. <li><a class="el" href="class_ragdoll.html" title="Runtime ragdoll information.">Ragdoll</a>: A scene with 16 piles of 10 ragdolls (3680 bodies) with motors active dropping on a level section.</li>
  116. <li>RagdollSinglePile: A single pile of 160 ragdolls (3680 bodies) with motors active dropping on a level section.</li>
  117. <li>ConvexVsMesh: A simpler scene of 484 convex shapes (sphere, box, convex hull, capsule) falling on a 2000 triangle mesh.</li>
  118. <li>Pyramid: A pyramid of 1240 boxes stacked on top of each other to profile large island splitting.</li>
  119. <li>LargeMesh: Searches for the biggest <a class="el" href="class_mesh_shape.html">MeshShape</a> that can be created and then drops 4410 boxes on that mesh.</li>
  120. </ul>
  121. </li>
  122. <li>-i=[iterations]: Number of physics steps before the test finishes.</li>
  123. <li>-q=[quality]: This limits the motion quality types that the test will run on. By default it will test both. [quality] can be:<ul>
  124. <li>Discrete: Discrete collision detection</li>
  125. <li>LinearCast: Linear cast continous collision detection</li>
  126. </ul>
  127. </li>
  128. <li>-t=[num]: This sets the amount of threads the test will run on. By default it will test 1 .. number of virtual processors. Can be 'max' to run on as many thread as the CPU has.</li>
  129. <li>-no_sleep: Disable sleeping.</li>
  130. <li>-p: Outputs a profile snapshot every 100 iterations</li>
  131. <li>-r: Outputs a performance_test_[tag].jor file that contains a recording to be played back with JoltViewer</li>
  132. <li>-f: Outputs the time taken per frame to per_frame_[tag].csv</li>
  133. <li>-h: Displays a help text</li>
  134. <li>-rs: Record the simulation state in state_[tag].bin.</li>
  135. <li>-vs: Validate the recorded simulation state from state_[tag].bin. This will after every simulation step check that the state is the same as the recorded state and trigger a breakpoint if this is not the case. This is used to validate cross platform determinism.</li>
  136. <li>-repeat=[num]: Repeats all tests num times.</li>
  137. <li>-validate_hash=[hash]: Will validate that the hash of the simulation matches the supplied hash. Program terminates with return code 1 if it doesn't. Can be used to automatically validate determinism.</li>
  138. </ul>
  139. <h1><a class="anchor" id="autotoc_md3"></a>
  140. Output</h1>
  141. <ul>
  142. <li>Motion Quality: Shows the motion quality for the test.</li>
  143. <li>Thread Count: The amount of threads used for the test.</li>
  144. <li>Steps / Second: Average amount of physics steps / second over the entire duration of the test.</li>
  145. <li><a class="el" href="struct_hash.html" title="Fallback hash function that calls T::GetHash()">Hash</a>: A hash of all positions and rotations of the bodies at the end of the test. Can be used to verify that the test was deterministic.</li>
  146. </ul>
  147. <h1><a class="anchor" id="autotoc_md4"></a>
  148. Results</h1>
  149. <p>If you're interested in how Jolt scales with multiple CPUs and compares to other physics engines, take a look at <a href="https://jrouwe.nl/jolt/JoltPhysicsMulticoreScaling.pdf">this document</a>. </p>
  150. </div></div><!-- contents -->
  151. </div><!-- PageDoc -->
  152. </div><!-- doc-content -->
  153. <!-- start footer part -->
  154. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  155. <ul>
  156. <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>
  157. </ul>
  158. </div>
  159. </body>
  160. </html>