<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iProfiler Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iProfiler Struct Reference</h1><!-- doxytag: class="iProfiler" --><!-- doxytag: inherits="iBase" -->Interface to profiler.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ivaria_2profile_8h-source.html">ivaria/profile.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iProfiler:</div>
<div class="dynsection">
<p><center><img src="structiProfiler__inherit__graph.png" border="0" usemap="#iProfiler__inherit__map" alt="Inheritance graph"></center>
<map name="iProfiler__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="12,7,68,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiProfiler-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="classCS_1_1Debug_1_1ProfileCounter.html">CS::Debug::ProfileCounter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#00d2e79697bff388c78f62d767e5f271">GetProfileCounter</a> (const char *countername)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to a profiler counter. <a href="#00d2e79697bff388c78f62d767e5f271"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="classcsArray.html">csArray</a><br>
< <a class="el" href="classCS_1_1Debug_1_1ProfileCounter.html">CS::Debug::ProfileCounter</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#27187ca1e4171cecae178adb8c7753a5">GetProfileCounters</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all profiler counters. <a href="#27187ca1e4171cecae178adb8c7753a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="classCS_1_1Debug_1_1ProfileZone.html">CS::Debug::ProfileZone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#5ae153c7de953785b2f4e265b73be891">GetProfileZone</a> (const char *zonename)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to a profiler zone. <a href="#5ae153c7de953785b2f4e265b73be891"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="classcsArray.html">csArray</a><br>
< <a class="el" href="classCS_1_1Debug_1_1ProfileZone.html">CS::Debug::ProfileZone</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#112653f1f04009afb9991e9a97e96d31">GetProfileZones</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all profiler zones. <a href="#112653f1f04009afb9991e9a97e96d31"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#9a7222674c6337b29ce453026847ca54">Reset</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset all zones and counters. <a href="#9a7222674c6337b29ce453026847ca54"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#f29714e592ba25062da0f9f897a3e732">StartLogging</a> (const char *filenamebase, <a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *objreg)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start logging profiling data to file. <a href="#f29714e592ba25062da0f9f897a3e732"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#8d277bacdf38231aeaa14a2d9b9f9fb7">StopLogging</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop logging. <a href="#8d277bacdf38231aeaa14a2d9b9f9fb7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Deprecated methods</div></td></tr>
<tr><td colspan="2"><div class="groupText"><dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000119">Deprecated:</a></b></dt><dd>These methods are present solely for source code compatibility; don't use.</dd></dl>
<br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9baf6912f76ea5ea9d4cba68c726d627"></a><!-- doxytag: member="iProfiler::Dump" ref="9baf6912f76ea5ea9d4cba68c726d627" args="()" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#9baf6912f76ea5ea9d4cba68c726d627">Dump</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="566966e9cbf07038d607eb106931cfbf"></a><!-- doxytag: member="iProfiler::RegisterProfilePoint" ref="566966e9cbf07038d607eb106931cfbf" args="(const char *, const char *, int, uint32 *, uint32 *, uint32 *, uint32 *)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProfiler.html#566966e9cbf07038d607eb106931cfbf">RegisterProfilePoint</a> (const char *, const char *, int, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface to profiler.
<p>Definition at line <a class="el" href="ivaria_2profile_8h-source.html#l00114">114</a> of file <a class="el" href="ivaria_2profile_8h-source.html">profile.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="00d2e79697bff388c78f62d767e5f271"></a><!-- doxytag: member="iProfiler::GetProfileCounter" ref="00d2e79697bff388c78f62d767e5f271" args="(const char *countername)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCS_1_1Debug_1_1ProfileCounter.html">CS::Debug::ProfileCounter</a>* iProfiler::GetProfileCounter </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>countername</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a profiler counter.
<p>
Will register a new counter if it doesn't exist. The pointer is guaranteed to be valid until the profiler object is destroyed.
</div>
</div><p>
<a class="anchor" name="27187ca1e4171cecae178adb8c7753a5"></a><!-- doxytag: member="iProfiler::GetProfileCounters" ref="27187ca1e4171cecae178adb8c7753a5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsArray.html">csArray</a><<a class="el" href="classCS_1_1Debug_1_1ProfileCounter.html">CS::Debug::ProfileCounter</a>*>& iProfiler::GetProfileCounters </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get all profiler counters.
<p>
</div>
</div><p>
<a class="anchor" name="5ae153c7de953785b2f4e265b73be891"></a><!-- doxytag: member="iProfiler::GetProfileZone" ref="5ae153c7de953785b2f4e265b73be891" args="(const char *zonename)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCS_1_1Debug_1_1ProfileZone.html">CS::Debug::ProfileZone</a>* iProfiler::GetProfileZone </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>zonename</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a profiler zone.
<p>
Will register a new zone if it doesn't exist. The pointer is guaranteed to be valid until the profiler object is destroyed.
</div>
</div><p>
<a class="anchor" name="112653f1f04009afb9991e9a97e96d31"></a><!-- doxytag: member="iProfiler::GetProfileZones" ref="112653f1f04009afb9991e9a97e96d31" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsArray.html">csArray</a><<a class="el" href="classCS_1_1Debug_1_1ProfileZone.html">CS::Debug::ProfileZone</a>*>& iProfiler::GetProfileZones </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get all profiler zones.
<p>
</div>
</div><p>
<a class="anchor" name="9a7222674c6337b29ce453026847ca54"></a><!-- doxytag: member="iProfiler::Reset" ref="9a7222674c6337b29ce453026847ca54" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProfiler::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset all zones and counters.
<p>
</div>
</div><p>
<a class="anchor" name="f29714e592ba25062da0f9f897a3e732"></a><!-- doxytag: member="iProfiler::StartLogging" ref="f29714e592ba25062da0f9f897a3e732" args="(const char *filenamebase, iObjectRegistry *objreg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProfiler::StartLogging </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filenamebase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>objreg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start logging profiling data to file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filenamebase</em> </td><td>Path and basic portion of filename. This will be postfixed with an unique id for every logging session. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objreg</em> </td><td>Object registry. If none is given, or the given object registry does not contain an <a class="el" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a> instance, <em>filenamebase</em> is treated as a native path. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8d277bacdf38231aeaa14a2d9b9f9fb7"></a><!-- doxytag: member="iProfiler::StopLogging" ref="8d277bacdf38231aeaa14a2d9b9f9fb7" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProfiler::StopLogging </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop logging.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="ivaria_2profile_8h-source.html">profile.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3478
