<!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: iSndSysSoftwareFilter3D 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>iSndSysSoftwareFilter3D Struct Reference<br>
<small>
[<a class="el" href="group__sndsys.html">Sound system</a>]</small>
</h1><!-- doxytag: class="iSndSysSoftwareFilter3D" --><!-- doxytag: inherits="iBase" -->A sound filter is an interface to an object that modifies sequences of sound samples.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ss__filter_8h-source.html">isndsys/ss_filter.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSndSysSoftwareFilter3D:</div>
<div class="dynsection">
<p><center><img src="structiSndSysSoftwareFilter3D__inherit__graph.png" border="0" usemap="#iSndSysSoftwareFilter3D__inherit__map" alt="Inheritance graph"></center>
<map name="iSndSysSoftwareFilter3D__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="68,7,124,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSndSysSoftwareFilter3D-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareFilter3D.html#1b62e07cc337ace50cfdac10dc452098">Apply</a> (<a class="el" href="structiSndSysSoftwareFilter3DProperties.html">iSndSysSoftwareFilter3DProperties</a> &properties)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply this filter to the mutable buffer passed. <a href="#1b62e07cc337ace50cfdac10dc452098"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiSndSysSoftwareFilter3D.html">iSndSysSoftwareFilter3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareFilter3D.html#98d70aa05f50b012237e9503d8d398a3">GetPtr</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the base pointer for this filter. <a href="#98d70aa05f50b012237e9503d8d398a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareFilter3D.html#c61bd306c27b46f6c89cc5daf3d8b09e">SCF_INTERFACE</a> (<a class="el" href="structiSndSysSoftwareFilter3D.html">iSndSysSoftwareFilter3D</a>, 0, 1, 0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">SCF2006 - See <a href="http://www.crystalspace3d.org/cseps/csep-0010.html.">http://www.crystalspace3d.org/cseps/csep-0010.html.</a> <a href="#c61bd306c27b46f6c89cc5daf3d8b09e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A sound filter is an interface to an object that modifies sequences of sound samples.
<p>Definition at line <a class="el" href="ss__filter_8h-source.html#l00057">57</a> of file <a class="el" href="ss__filter_8h-source.html">ss_filter.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1b62e07cc337ace50cfdac10dc452098"></a><!-- doxytag: member="iSndSysSoftwareFilter3D::Apply" ref="1b62e07cc337ace50cfdac10dc452098" args="(iSndSysSoftwareFilter3DProperties &properties)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysSoftwareFilter3D::Apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysSoftwareFilter3DProperties.html">iSndSysSoftwareFilter3DProperties</a> & </td>
<td class="paramname"> <em>properties</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply this filter to the mutable buffer passed.
<p>
The unmutable main buffer is also passed, although this is not likely to be very useful, since the main buffer has an unknown number of sources previously mixed in (possibly none). The sample_count is the number of samples available in both the mutable buffer and the main buffer. The format is the format of the audio.
</div>
</div><p>
<a class="anchor" name="98d70aa05f50b012237e9503d8d398a3"></a><!-- doxytag: member="iSndSysSoftwareFilter3D::GetPtr" ref="98d70aa05f50b012237e9503d8d398a3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSndSysSoftwareFilter3D.html">iSndSysSoftwareFilter3D</a>* iSndSysSoftwareFilter3D::GetPtr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the base pointer for this filter.
<p>
Used internally by the sound system.
</div>
</div><p>
<a class="anchor" name="c61bd306c27b46f6c89cc5daf3d8b09e"></a><!-- doxytag: member="iSndSysSoftwareFilter3D::SCF_INTERFACE" ref="c61bd306c27b46f6c89cc5daf3d8b09e" args="(iSndSysSoftwareFilter3D, 0, 1, 0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">iSndSysSoftwareFilter3D::SCF_INTERFACE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysSoftwareFilter3D.html">iSndSysSoftwareFilter3D</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">0 </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">1 </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">0 </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
SCF2006 - See <a href="http://www.crystalspace3d.org/cseps/csep-0010.html.">http://www.crystalspace3d.org/cseps/csep-0010.html.</a>
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>isndsys/<a class="el" href="ss__filter_8h-source.html">ss_filter.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
>
3742
