Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1470

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csplugincommon/sndsys/cyclicbuf.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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csplugincommon/sndsys/cyclicbuf.h</h1><a href="cyclicbuf_8h.html">Go to the documentation of this file.</a><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) 2004 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_CYCLICBUF_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SNDSYS_CYCLICBUF_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="keyword">namespace </span>CS
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <span class="keyword">namespace </span>SndSys
<a name="l00029"></a>00029 {
<a name="l00030"></a>00030 
<a name="l00034"></a><a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html">00034</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html" title="An implementation of a cyclic buffer oriented for sound functionality.">SoundCyclicBuffer</a>
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00038"></a>00038   <a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html" title="An implementation of a cyclic buffer oriented for sound functionality.">SoundCyclicBuffer</a>(<span class="keywordtype">size_t</span> buffer_size);
<a name="l00039"></a>00039   ~<a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html" title="An implementation of a cyclic buffer oriented for sound functionality.">SoundCyclicBuffer</a>();
<a name="l00040"></a>00040 
<a name="l00042"></a>00042   <span class="keywordtype">size_t</span> GetFreeBytes();
<a name="l00043"></a>00043   
<a name="l00049"></a>00049   <span class="keywordtype">void</span> AddBytes(<span class="keywordtype">void</span> *bytes_ptr, <span class="keywordtype">size_t</span> bytes_length);
<a name="l00050"></a>00050 
<a name="l00054"></a>00054   <span class="keywordtype">size_t</span> GetStartValue();
<a name="l00059"></a>00059   <span class="keywordtype">size_t</span> GetEndValue();
<a name="l00064"></a>00064   <span class="keywordtype">void</span> AdvanceStartValue (<span class="keywordtype">size_t</span> advance_amount);
<a name="l00065"></a>00065 
<a name="l00069"></a>00069   <span class="keywordtype">void</span> Clear (<span class="keywordtype">long</span> value=0);
<a name="l00070"></a>00070 
<a name="l00074"></a>00074   <span class="keywordtype">void</span> GetDataPointersFromPosition (<span class="keywordtype">size_t</span>* position_value, <span class="keywordtype">size_t</span> max_length, 
<a name="l00075"></a>00075     <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> **buffer1, <span class="keywordtype">size_t</span>* buffer1_length, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> **buffer2, 
<a name="l00076"></a>00076     <span class="keywordtype">size_t</span>* buffer2_length);
<a name="l00077"></a>00077 
<a name="l00081"></a><a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html#999ada136bfaca226586fba89680ad60">00081</a>   <span class="keywordtype">size_t</span> GetLength() { <span class="keywordflow">return</span> length; };
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="keyword">private</span>:
<a name="l00085"></a>00085   <span class="keywordtype">size_t</span> length;
<a name="l00087"></a>00087 
<a name="l00091"></a>00091   <span class="keywordtype">size_t</span> start_value;
<a name="l00092"></a>00092   <span class="keywordtype">size_t</span> end_value;
<a name="l00094"></a>00094 
<a name="l00096"></a>00096 
<a name="l00100"></a>00100   <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> *buffer_base;
<a name="l00101"></a>00101   <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> *write_ptr;
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 } <span class="comment">// namespace SndSys</span>
<a name="l00106"></a>00106 } <span class="comment">// namespace CS</span>
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="preprocessor">#endif // __CS_SNDSYS_CYCLICBUF_H__</span>
</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional