blob: 450b60a220007f12e78febc12f4b30177795af37 [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>32blit API: engine/profiler.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">32blit API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('profiler_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">profiler.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Profiler module</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// A Profiler can have multiple ProfilerProbes</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// A ProfilerProbe has a set of metrics measures in us: Min Value, Max Value, Current value, Average value</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// The average value is calculated from a running average which can be set in the ProfilerProbe constructor along with the span</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Values can be logged to CDC via LogProbes()</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Values can be displayed as an overlay when called at the end of Render() using DisplayProbeOverlay()</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// For examples of use and setup please see the profiler-test example.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;running_average.hpp&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;graphics/surface.hpp&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblit.html">blit</a></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classblit_1_1ProfilerProbe.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structblit_1_1ProfilerProbe_1_1Metrics.html"> 30</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1ProfilerProbe_1_1Metrics.html">Metrics</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint32_t operator[] (std::size_t i)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">if</span>(i==0)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> uMinElapsedUs;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">if</span>(i==1)</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> uElapsedUs;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span>(i==2)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">return</span> uAvgElapsedUs;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">if</span>(i==3)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> uMaxElapsedUs;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="structblit_1_1ProfilerProbe_1_1Metrics.html">Metrics</a>()</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; clear();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> clear()</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uElapsedUs = 0;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uMinElapsedUs = UINT32_MAX;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uMaxElapsedUs = 0;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uAvgElapsedUs = 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; uint32_t uElapsedUs;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint32_t uMinElapsedUs;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint32_t uMaxElapsedUs;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint32_t uAvgElapsedUs;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; };</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *pszName, uint32_t uRunningAverageSize = 0, uint32_t uRunningAverageSpan = 1) : m_pszName(pszName), m_uStartUs(0), m_metrics(), m_pRunningAverage(nullptr), m_uGraphTimeUs(20000)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span>(uRunningAverageSize)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; m_pRunningAverage = <span class="keyword">new</span> <a class="code" href="classblit_1_1RunningAverage.html">RunningAverage&lt;float&gt;</a>(uRunningAverageSize);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordflow">if</span>(uRunningAverageSpan == 0)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; m_uRunningAverageSpan = 1;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; m_uRunningAverageSpan = uRunningAverageSpan;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; m_uRunningAverageSpanIndex = m_uRunningAverageSpan-1;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; };</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">void</span> start();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">void</span> clear()</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; m_pRunningAverage-&gt;reset();</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; m_metrics.clear();</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; m_uStartUs = 0;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; uint32_t store_elapsed_us(<span class="keywordtype">bool</span> bRestart = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">const</span> Metrics &amp;elapsed_metrics()</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> m_metrics;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name()</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">return</span> m_pszName;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> RunningAverage&lt;float&gt; *get_running_average()</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">return</span> m_pRunningAverage;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">void</span> set_graph_time_us(uint32_t uGraphTimeUs)</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; m_uGraphTimeUs = uGraphTimeUs;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">void</span> set_graph_time_us_to_max()</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; {</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; m_uGraphTimeUs = m_metrics.uMaxElapsedUs;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; uint32_t get_graph_time_us()</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> m_uGraphTimeUs;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; }</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *m_pszName;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; uint32_t m_uStartUs;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; Metrics m_metrics;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; RunningAverage&lt;float&gt; *m_pRunningAverage;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; uint32_t m_uRunningAverageSpan;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; uint32_t m_uRunningAverageSpanIndex;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; uint32_t m_uGraphTimeUs;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;};</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classblit_1_1ScopedProfilerProbe.html"> 132</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;{</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a> (<a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *pProbe)</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; : m_pProbe(pProbe)</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; m_pProbe-&gt;start();</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; }</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; ~<a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a> ()</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; {</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; m_pProbe-&gt;store_elapsed_us();</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; }</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a> ( <a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a> &amp; ) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">void</span> operator = ( <a class="code" href="classblit_1_1ScopedProfilerProbe.html">ScopedProfilerProbe</a> &amp; ) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *m_pProbe;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;};</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; </div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classblit_1_1Profiler.html"> 153</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblit_1_1Profiler.html">Profiler</a></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;{</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keyword">using</span> ProfilerProbes = std::vector&lt;ProfilerProbe *&gt;;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keyword">enum</span> DisplayMetric {dmMin, dmCur, dmAvg, dmMax};</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="structblit_1_1Profiler_1_1GraphElement.html"> 160</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; {</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <a class="code" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a>(): color(<a class="code" href="structblit_1_1Pen.html">Pen</a>(0,255,0)) {};</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordtype">bool</span> bDisplayLabel = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keywordtype">bool</span> bDisplayGraph = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="structblit_1_1Pen.html">Pen</a> color;</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; };</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <a class="code" href="classblit_1_1Profiler.html">Profiler</a>(uint32_t uRunningAverageSize = 0, uint32_t uRunningAverageSpan = 1);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classblit_1_1Profiler.html">Profiler</a>();</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *add_probe(<span class="keyword">const</span> <span class="keywordtype">char</span> *pszName);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *add_probe(<span class="keyword">const</span> <span class="keywordtype">char</span> *pszName, uint32_t uRunningAverageSize, uint32_t uRunningAverageSpan=1);</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordtype">void</span> remove_probe(<a class="code" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *pProbe);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keywordtype">void</span> start_all_probes();</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keywordtype">void</span> clear_all_probes();</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordtype">void</span> log_probes();</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordtype">size_t</span> get_probe_count();</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keywordtype">size_t</span> get_page_count();</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <span class="keywordtype">void</span> set_display_size(uint16_t uWidth, uint32_t uHeight);</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordtype">void</span> set_graph_time(uint32_t uTimeUs);</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordtype">void</span> set_rows(uint8_t uRows);</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordtype">void</span> set_alpha(uint8_t uAlpha);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keywordtype">void</span> display_probe_overlay(uint8_t uPage);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordtype">void</span> display_history(<span class="keywordtype">bool</span> bDisplayHistory, <a class="code" href="structblit_1_1Pen.html">Pen</a> color = <a class="code" href="structblit_1_1Pen.html">Pen</a>(0,255,0));</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keywordtype">void</span> setup_graph_element(DisplayMetric metric, <span class="keywordtype">bool</span> bDisplayLabel, <span class="keywordtype">bool</span> bDisplayGraph, <a class="code" href="structblit_1_1Pen.html">Pen</a> color);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <a class="code" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a> &amp;get_graph_element(DisplayMetric metric);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *g_pszMetricNames[];</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; ProfilerProbes m_probes;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <a class="code" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a> m_graphElements[dmMax+1];</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; </div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; uint16_t m_uWidth;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; uint16_t m_uHeight;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; uint16_t m_uRows;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; int32_t m_uGraphTimeUs;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; uint32_t m_uRunningAverageSize;</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; uint32_t m_uRunningAverageSpan;</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; uint16_t m_uRowHeight;</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; uint16_t m_uBorder;</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; uint16_t m_uHeaderSize;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; uint8_t m_uAlpha;</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <span class="keywordtype">bool</span> m_bDisplayHistory;</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <a class="code" href="structblit_1_1Pen.html">Pen</a> m_historyColor;</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; </div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;};</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;}; <span class="comment">// namespace</span></div>
<div class="ttc" id="aclassblit_1_1ProfilerProbe_html"><div class="ttname"><a href="classblit_1_1ProfilerProbe.html">blit::ProfilerProbe</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:28</div></div>
<div class="ttc" id="aclassblit_1_1Profiler_html"><div class="ttname"><a href="classblit_1_1Profiler.html">blit::Profiler</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:154</div></div>
<div class="ttc" id="aclassblit_1_1RunningAverage_html"><div class="ttname"><a href="classblit_1_1RunningAverage.html">blit::RunningAverage&lt; float &gt;</a></div></div>
<div class="ttc" id="aclassblit_1_1ScopedProfilerProbe_html"><div class="ttname"><a href="classblit_1_1ScopedProfilerProbe.html">blit::ScopedProfilerProbe</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:133</div></div>
<div class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div>
<div class="ttc" id="astructblit_1_1Pen_html"><div class="ttname"><a href="structblit_1_1Pen.html">blit::Pen</a></div><div class="ttdef"><b>Definition:</b> surface.hpp:96</div></div>
<div class="ttc" id="astructblit_1_1ProfilerProbe_1_1Metrics_html"><div class="ttname"><a href="structblit_1_1ProfilerProbe_1_1Metrics.html">blit::ProfilerProbe::Metrics</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:31</div></div>
<div class="ttc" id="astructblit_1_1Profiler_1_1GraphElement_html"><div class="ttname"><a href="structblit_1_1Profiler_1_1GraphElement.html">blit::Profiler::GraphElement</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:161</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_996f45160da62e1a3d7f6046fad68f51.html">engine</a></li><li class="navelem"><b>profiler.hpp</b></li>
<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.9.1 </li>
</ul>
</div>
</body>
</html>