blob: 5fc04212ef8ccaaebc6071830aba813a58bfb861 [file] [edit]
<!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: blit::Profiler Class Reference</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('classblit_1_1Profiler.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="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classblit_1_1Profiler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">blit::Profiler Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a44227df024e9e2331809154baebfdb9c"><td class="memItemLeft" align="right" valign="top"><a id="a44227df024e9e2331809154baebfdb9c"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>DisplayMetric</b> { <b>dmMin</b>
, <b>dmCur</b>
, <b>dmAvg</b>
, <b>dmMax</b>
}</td></tr>
<tr class="separator:a44227df024e9e2331809154baebfdb9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f49912229dadddc91f8af4ed5adb00f"><td class="memItemLeft" align="right" valign="top"><a id="a0f49912229dadddc91f8af4ed5adb00f"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>ProfilerProbes</b> = std::vector&lt; <a class="el" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> * &gt;</td></tr>
<tr class="separator:a0f49912229dadddc91f8af4ed5adb00f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aad630028802f1c04a6909023b39f06d3"><td class="memItemLeft" align="right" valign="top"><a id="aad630028802f1c04a6909023b39f06d3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Profiler</b> (uint32_t uRunningAverageSize=0, uint32_t uRunningAverageSpan=1)</td></tr>
<tr class="separator:aad630028802f1c04a6909023b39f06d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3852e41ada64aea7f0145980bd7ff0a"><td class="memItemLeft" align="right" valign="top"><a id="ac3852e41ada64aea7f0145980bd7ff0a"></a>
<a class="el" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>add_probe</b> (const char *pszName)</td></tr>
<tr class="separator:ac3852e41ada64aea7f0145980bd7ff0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa23c4e5ef64dfd4ecbc890335855e455"><td class="memItemLeft" align="right" valign="top"><a id="aa23c4e5ef64dfd4ecbc890335855e455"></a>
<a class="el" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>add_probe</b> (const char *pszName, uint32_t uRunningAverageSize, uint32_t uRunningAverageSpan=1)</td></tr>
<tr class="separator:aa23c4e5ef64dfd4ecbc890335855e455"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ae083312378ae2a58b96cccf1421cc6"><td class="memItemLeft" align="right" valign="top"><a id="a1ae083312378ae2a58b96cccf1421cc6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>remove_probe</b> (<a class="el" href="classblit_1_1ProfilerProbe.html">ProfilerProbe</a> *pProbe)</td></tr>
<tr class="separator:a1ae083312378ae2a58b96cccf1421cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f61a9ec2f3179450dd2103e3347b36"><td class="memItemLeft" align="right" valign="top"><a id="a57f61a9ec2f3179450dd2103e3347b36"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>start_all_probes</b> ()</td></tr>
<tr class="separator:a57f61a9ec2f3179450dd2103e3347b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a3e79db7c8fa77a13a75006e4bb9d96"><td class="memItemLeft" align="right" valign="top"><a id="a5a3e79db7c8fa77a13a75006e4bb9d96"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear_all_probes</b> ()</td></tr>
<tr class="separator:a5a3e79db7c8fa77a13a75006e4bb9d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15663a0ee1b7e9e33d8e7b6191e3a7df"><td class="memItemLeft" align="right" valign="top"><a id="a15663a0ee1b7e9e33d8e7b6191e3a7df"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>log_probes</b> ()</td></tr>
<tr class="separator:a15663a0ee1b7e9e33d8e7b6191e3a7df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dffd0578a71c3716aada99c13334bf7"><td class="memItemLeft" align="right" valign="top"><a id="a8dffd0578a71c3716aada99c13334bf7"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>get_probe_count</b> ()</td></tr>
<tr class="separator:a8dffd0578a71c3716aada99c13334bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af109560f054c393341bc8583ae6847f5"><td class="memItemLeft" align="right" valign="top"><a id="af109560f054c393341bc8583ae6847f5"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>get_page_count</b> ()</td></tr>
<tr class="separator:af109560f054c393341bc8583ae6847f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dbc0053cb3474ce18af15686da6da10"><td class="memItemLeft" align="right" valign="top"><a id="a0dbc0053cb3474ce18af15686da6da10"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_display_size</b> (uint16_t uWidth, uint32_t uHeight)</td></tr>
<tr class="separator:a0dbc0053cb3474ce18af15686da6da10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6b5196291e139c2168dca6762d68b6e"><td class="memItemLeft" align="right" valign="top"><a id="ac6b5196291e139c2168dca6762d68b6e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_graph_time</b> (uint32_t uTimeUs)</td></tr>
<tr class="separator:ac6b5196291e139c2168dca6762d68b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0072b05b2ae61d51e704d3a68bc92ae"><td class="memItemLeft" align="right" valign="top"><a id="aa0072b05b2ae61d51e704d3a68bc92ae"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_rows</b> (uint8_t uRows)</td></tr>
<tr class="separator:aa0072b05b2ae61d51e704d3a68bc92ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29f607f1c92efbd61bbe744a41e9fa85"><td class="memItemLeft" align="right" valign="top"><a id="a29f607f1c92efbd61bbe744a41e9fa85"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_alpha</b> (uint8_t uAlpha)</td></tr>
<tr class="separator:a29f607f1c92efbd61bbe744a41e9fa85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5c257d2cbf257cf2fb32ac2edf9fbe9"><td class="memItemLeft" align="right" valign="top"><a id="ab5c257d2cbf257cf2fb32ac2edf9fbe9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>display_probe_overlay</b> (uint8_t uPage)</td></tr>
<tr class="separator:ab5c257d2cbf257cf2fb32ac2edf9fbe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab78255760a365f5b8b2b5b0a5626454c"><td class="memItemLeft" align="right" valign="top"><a id="ab78255760a365f5b8b2b5b0a5626454c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>display_history</b> (bool bDisplayHistory, <a class="el" href="structblit_1_1Pen.html">Pen</a> color=<a class="el" href="structblit_1_1Pen.html">Pen</a>(0, 255, 0))</td></tr>
<tr class="separator:ab78255760a365f5b8b2b5b0a5626454c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88f3276f2dd0b9102d75a18c0db1ef3c"><td class="memItemLeft" align="right" valign="top"><a id="a88f3276f2dd0b9102d75a18c0db1ef3c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setup_graph_element</b> (DisplayMetric metric, bool bDisplayLabel, bool bDisplayGraph, <a class="el" href="structblit_1_1Pen.html">Pen</a> color)</td></tr>
<tr class="separator:a88f3276f2dd0b9102d75a18c0db1ef3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae840d70806c7c1b1a4a889ec9c3da642"><td class="memItemLeft" align="right" valign="top"><a id="ae840d70806c7c1b1a4a889ec9c3da642"></a>
<a class="el" href="structblit_1_1Profiler_1_1GraphElement.html">GraphElement</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_graph_element</b> (DisplayMetric metric)</td></tr>
<tr class="separator:ae840d70806c7c1b1a4a889ec9c3da642"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>engine/<a class="el" href="profiler_8hpp_source.html">profiler.hpp</a></li>
<li>engine/profiler.cpp</li>
</ul>
</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="namespaceblit.html">blit</a></li><li class="navelem"><a class="el" href="classblit_1_1Profiler.html">Profiler</a></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>