|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `hprof` crate."><meta name="keywords" content="rust, rustlang, rust-lang, hprof"><title>hprof - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../hprof/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate hprof</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all hprof's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'hprof', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/hprof/lib.rs.html#6-333' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>hprof</a></span></h1><div class='docblock'><p>A real-time hierarchical profiler.</p>
|
|
|
<h1 id="what-is-hierarchical-profiling" class="section-header"><a href="#what-is-hierarchical-profiling">What is hierarchical profiling?</a></h1>
|
|
|
<p>Hierarchical profiling is based on the observation that games are typically
|
|
|
organized into a "tree" of behavior. You have an AI system that does path
|
|
|
planning, making tactical decisions, etc. You have a physics system that does
|
|
|
collision detection, rigid body dynamics, etc. A tree might look like:</p>
|
|
|
<ul>
|
|
|
<li>Physics
|
|
|
<ul>
|
|
|
<li>Collision detection
|
|
|
<ul>
|
|
|
<li>Broad phase</li>
|
|
|
<li>Narrow phase</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>Fluid simulation</li>
|
|
|
<li>Rigid body simulation
|
|
|
<ul>
|
|
|
<li>Collision resolution</li>
|
|
|
<li>Update positions</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>AI
|
|
|
<ul>
|
|
|
<li>Path planning</li>
|
|
|
<li>Combat tactics</li>
|
|
|
<li>Build queue maintenance</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>Render
|
|
|
<ul>
|
|
|
<li>Frustum culling</li>
|
|
|
<li>Draw call sorting</li>
|
|
|
<li>Draw call submission</li>
|
|
|
<li>GPU wait</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<p>A hierarchical profiler will annotate this tree with how much time each step
|
|
|
took. This is an extension of timer-based profiling, where a timer is used to
|
|
|
measure how long a block of code takes to execute. Rather than coding up a
|
|
|
one-time timer, you merely call <code>Profiler::enter("description of thing")</code> and
|
|
|
a new entry will be made in the profile tree.</p>
|
|
|
<p>The idea came from a 2002 article in Game Programming Gems 3, "Real-Time
|
|
|
Hierarchical Profiling" by Greg Hjelstrom and Byon Garrabrant from Westwood
|
|
|
Studios. They report having thousands of profile nodes active at a time.</p>
|
|
|
<p>There are two major ways to use this library: with explicit profilers, and with an implicit
|
|
|
profiler.</p>
|
|
|
<h1 id="implicit-thread-local-profiler" class="section-header"><a href="#implicit-thread-local-profiler">Implicit (thread-local) profiler</a></h1>
|
|
|
<p>To use the implicit profiler, call <code>hprof::start_frame()</code>, <code>hprof::end_frame()</code>, and
|
|
|
<code>hprof::enter("name")</code>. Destructors will take care of the rest. You can access the profiler
|
|
|
using <code>hprof::profiler()</code>.</p>
|
|
|
<h1 id="explicit-profilers" class="section-header"><a href="#explicit-profilers">Explicit profilers</a></h1>
|
|
|
<p>Use <code>Profiler::new()</code> and pass it around/store it somewhere (for example, using
|
|
|
<a href="https://github.com/PistonDevelopers/current"><code>current</code></a>).</p>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.ProfileGuard.html" title='hprof::ProfileGuard struct'>ProfileGuard</a></td><td class='docblock-short'><p>A "guard" for calling <code>Profiler::leave</code> when it is destroyed.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ProfileNode.html" title='hprof::ProfileNode struct'>ProfileNode</a></td><td class='docblock-short'><p>A single node in the profile tree.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Profiler.html" title='hprof::Profiler struct'>Profiler</a></td><td class='docblock-short'><p>A single tree of profile data.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.end_frame.html" title='hprof::end_frame fn'>end_frame</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.enter.html" title='hprof::enter fn'>enter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.profiler.html" title='hprof::profiler fn'>profiler</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.start_frame.html" title='hprof::start_frame fn'>start_frame</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "hprof";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
