<!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: isndsys/ss_eventrecorder.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>isndsys/ss_eventrecorder.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">Copyright (C) 2006 by Andrew Mann</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef CS_SNDSYS_EVENTRECORDER_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define CS_SNDSYS_EVENTRECORDER_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="keyword">struct </span><a class="code" href="structiSndSysEventRecorder.html" title="An interface designed for the debugging needs of the sound system.">iSndSysEventRecorder</a>;
<a name="l00023"></a>00023
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 SSEL_BUG, <span class="comment">// This event is surely a bug in our code - think of it like a loggable assertion</span>
<a name="l00028"></a>00028 SSEL_CRITICAL, <span class="comment">// This event is so important you must absolutely know about it. It may or may not be a bug in our code.</span>
<a name="l00029"></a>00029 SSEL_ERROR, <span class="comment">// Something bad happened for sure, but we can deal with it</span>
<a name="l00030"></a>00030 SSEL_WARNING, <span class="comment">// Something bad _might_ be happening</span>
<a name="l00031"></a>00031 SSEL_DEBUG <span class="comment">// General information that's really good to know for debugging purposes</span>
<a name="l00032"></a>00032 } SndSysEventLevel;
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 SSEC_DRIVER, <span class="comment">// Event is related to the driver</span>
<a name="l00037"></a>00037 SSEC_RENDERER, <span class="comment">// Event is related to the renderer, but not particularly a source or stream</span>
<a name="l00038"></a>00038 SSEC_SOURCE, <span class="comment">// Event is related to a particular source</span>
<a name="l00039"></a>00039 SSEC_STREAM, <span class="comment">// Event is related to a particular stream element</span>
<a name="l00040"></a>00040 SSEC_DATA <span class="comment">// Event is relayed to a data element</span>
<a name="l00041"></a>00041 } SndSysEventCategory;
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00048"></a>00048 <span class="comment">//</span>
<a name="l00049"></a>00049 <span class="comment">// Important events in the sound system happen many times per second. Logging or reporting such a massive amount</span>
<a name="l00050"></a>00050 <span class="comment">// of data can be unweildy (and annoying if you're not debugging the sound system).</span>
<a name="l00051"></a>00051 <span class="comment">//</span>
<a name="l00052"></a>00052 <span class="comment">// Additionally, sound events are often time critical - just knowing that a buffer was filled after some other action</span>
<a name="l00053"></a>00053 <span class="comment">// is frequently not enough. A frequent requirement is to know the exact time between two events - as precise as possible.</span>
<a name="l00054"></a>00054 <span class="comment">//</span>
<a name="l00055"></a>00055 <span class="comment">// This interface provides these services for the sound system.</span>
<a name="l00056"></a><a class="code" href="structiSndSysEventRecorder.html">00056</a> <span class="keyword">struct </span><a class="code" href="structiSndSysEventRecorder.html" title="An interface designed for the debugging needs of the sound system.">iSndSysEventRecorder</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00057"></a>00057 {
<a name="l00059"></a>00059 <a class="code" href="structiSndSysEventRecorder.html#02f9fe30113326de1881a226dbd6dd82" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a> (<a class="code" href="structiSndSysEventRecorder.html" title="An interface designed for the debugging needs of the sound system.">iSndSysEventRecorder</a>, 1, 0, 0);
<a name="l00060"></a>00060
<a name="l00062"></a>00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysEventRecorder.html#fc9a739377b01e97ced0255e02ed2408" title="Log an event with typical variable argument format.">RecordEvent</a>(SndSysEventCategory, SndSysEventLevel, <span class="keyword">const</span> <span class="keywordtype">char</span>* Description, ...) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00063"></a>00063
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysEventRecorder.html#546fcfa85039f9014231ec4e67c22fd7" title="Log an event with va_list argument passing - useful if you have a logging wrapper...">RecordEventV</a>(SndSysEventCategory, SndSysEventLevel, <span class="keyword">const</span> <span class="keywordtype">char</span>* Description, va_list) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 0) = 0;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="preprocessor">#endif // #ifndef CS_SNDSYS_EVENTRECORDER_H</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span>
<a name="l00072"></a>00072
</pre></div><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
>
2344
