<!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_source.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_source.h</h1><a href="ss__source_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"> Copyright (C) 1998-2000 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_SNDSYS_ISNDSYS_SOURCE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SNDSYS_ISNDSYS_SOURCE_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="vector3_8h.html" title="3D vector.">csgeom/vector3.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="ss__structs_8h.html" title="Sound system: types.">isndsys/ss_structs.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="ss__filter_8h.html" title="Sound system: software filters.">isndsys/ss_filter.h</a>"</span>
<a name="l00031"></a>00031
<a name="l00036"></a>00036 <span class="keyword">struct </span>iSndSysFilter;
<a name="l00037"></a>00037 <span class="keyword">struct </span><a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a>;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#ifndef CS_SNDSYS_SOURCE_DISTANCE_INFINITE</span>
<a name="l00040"></a><a class="code" href="group__sndsys.html#g166882a13c2046e4baf3633479d7c229">00040</a> <span class="preprocessor"></span><span class="preprocessor">#define CS_SNDSYS_SOURCE_DISTANCE_INFINITE -1.0f</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00046"></a><a class="code" href="structiSndSysSource.html">00046</a> <span class="keyword">struct </span><a class="code" href="structiSndSysSource.html">iSndSysSource</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="l00047"></a>00047 {
<a name="l00049"></a>00049 <a class="code" href="structiSndSysSource.html#7441c047b4990c7956c6601ce25f5e53" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysSource.html">iSndSysSource</a>,2,0,0);
<a name="l00050"></a>00050
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSource.html#f0fc98916ff90fbb56772ed8d8945530" title="Set volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud).">SetVolume</a> (<span class="keywordtype">float</span> volume) = 0;
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSndSysSource.html#7971c3feebb60c505967a314ce090eaa" title="Get volume (0.0 = silence, 1.0 = as provided, 2.0 = twice as loud).">GetVolume</a> () = 0;
<a name="l00055"></a>00055
<a name="l00057"></a>00057 <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iSndSysStream></a> <a class="code" href="structiSndSysSource.html#9d1eed578947d1ac3a1df2236ca6ebd3" title="Retrieve the iSoundStream attached to this source.">GetStream</a>() = 0;
<a name="l00058"></a>00058
<a name="l00060"></a>00060 <span class="comment">// Output filters can only receive sound data and cannot modify it. They will receive data</span>
<a name="l00061"></a>00061 <span class="comment">// from the same thread that the CS event handler executes in, once per frame.</span>
<a name="l00062"></a>00062 <span class="comment">//</span>
<a name="l00063"></a>00063 <span class="comment">// Valid Locations: SS_FILTER_LOC_SOURCEOUT, SS_FILTER_LOC_SOURCEIN</span>
<a name="l00064"></a>00064 <span class="comment">// </span>
<a name="l00065"></a>00065 <span class="comment">// Returns FALSE if the filter could not be added.</span>
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysSource.html#2cd2c70891c9454c558b2921dbc83da6" title="Add an output filter at the specified location.">AddOutputFilter</a>(<a class="code" href="group__sndsys.html#g02040177da92d61fbeac3125aef7ddcc" title="Possible locations at which filters may be installed into the sound system.">SndSysFilterLocation</a> Location, <a class="code" href="structiSndSysSoftwareOutputFilter.html" title="Temporary filter interface definition.">iSndSysSoftwareOutputFilter</a> *pFilter) = 0;
<a name="l00067"></a>00067
<a name="l00069"></a>00069 <span class="comment">//</span>
<a name="l00070"></a>00070 <span class="comment">// Valid Locations: SS_FILTER_LOC_SOURCEOUT, SS_FILTER_LOC_SOURCEIN</span>
<a name="l00071"></a>00071 <span class="comment">//</span>
<a name="l00072"></a>00072 <span class="comment">// Returns FALSE if the filter is not in the list at the time of the call.</span>
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysSource.html#1ecfaa1fe0f14c9fcde841814ce3d81b" title="Remove an output filter from the registered list.">RemoveOutputFilter</a>(<a class="code" href="group__sndsys.html#g02040177da92d61fbeac3125aef7ddcc" title="Possible locations at which filters may be installed into the sound system.">SndSysFilterLocation</a> Location, <a class="code" href="structiSndSysSoftwareOutputFilter.html" title="Temporary filter interface definition.">iSndSysSoftwareOutputFilter</a> *pFilter) = 0;
<a name="l00074"></a>00074
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <a class="code" href="structiSndSysSource.html">iSndSysSource</a> *<a class="code" href="structiSndSysSource.html#ebb47e91d376e6a997fde48f90c5efb5" title="Retrieve a direct pointer to this object.">GetPtr</a>() = 0;
<a name="l00077"></a>00077 };
<a name="l00078"></a>00078
<a name="l00082"></a><a class="code" href="structiSndSysSourceSoftware.html">00082</a> <span class="keyword">struct </span><a class="code" href="structiSndSysSourceSoftware.html">iSndSysSourceSoftware</a> : <span class="keyword">public</span> <a class="code" href="structiSndSysSource.html">iSndSysSource</a>
<a name="l00083"></a>00083 {
<a name="l00085"></a>00085 <a class="code" href="structiSndSysSourceSoftware.html#0df12cc19fcdb0a24208bc89b42614c5" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysSourceSoftware.html">iSndSysSourceSoftware</a>,2,0,0);
<a name="l00086"></a>00086
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiSndSysSourceSoftware.html#036cec3e3c94cbb0d5b6d47fc8e78186" title="Renderer convenience interface - requests the source to fill the supplied buffers...">MergeIntoBuffer</a>(<a class="code" href="group__sndsys.html#gc8eb30abac5547e09b41e96e87100ff7">csSoundSample</a> *frame_buffer, <span class="keywordtype">size_t</span> frame_count) = 0;
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware.html#6829bcef9b7d76b43dae2569341ab0e4" title="Renderer convenience interface - Called to provide processing of output filters.">ProcessOutputFilters</a>() = 0;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00108"></a><a class="code" href="structiSndSysSourceSoftware3D.html">00108</a> <span class="keyword">struct </span><a class="code" href="structiSndSysSourceSoftware3D.html">iSndSysSourceSoftware3D</a> : <span class="keyword">public</span> <a class="code" href="structiSndSysSourceSoftware.html">iSndSysSourceSoftware</a>
<a name="l00109"></a>00109 {
<a name="l00111"></a>00111 <a class="code" href="structiSndSysSourceSoftware3D.html#da92136a00ae0d896c8e83bfd2741438" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysSourceSoftware3D.html">iSndSysSourceSoftware3D</a>,2,0,0);
<a name="l00112"></a>00112
<a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware3D.html#fb7435ab41ff6a021877436919399ea7" title="set position of this source">SetPosition</a>(<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> pos) = 0;
<a name="l00116"></a>00116 <span class="keyword">virtual</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> <a class="code" href="structiSndSysSourceSoftware3D.html#a11fdc79aee9e45dcd654c3e18870f2c" title="get position of this source">GetPosition</a>() = 0;
<a name="l00117"></a>00117
<a name="l00119"></a>00119 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware3D.html#07bef279fb61a12620ebaefcdb5d85fc" title="set position of this source">SetDirection</a>(<a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> dir) = 0;
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> <a class="code" href="structiSndSysSourceSoftware3D.html#02d4b7d680c76777d27a6e1e439844c6" title="get position of this source">GetDirection</a>() = 0;
<a name="l00122"></a>00122
<a name="l00131"></a>00131 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware3D.html#9b4e88c26c6a2a7c030eb73b2e85c2d6" title="The directional radiation applies to sound that are oriented in a particular direction...">SetDirectionalRadiation</a>(<span class="keywordtype">float</span> rad) = 0;
<a name="l00132"></a>00132
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSndSysSourceSoftware3D.html#3128def3ae32de24ebe145df7fe08da1" title="Retrieves the current directional radiation.">GetDirectionalRadiation</a>() = 0;
<a name="l00135"></a>00135
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware3D.html#75b262db0ef460d8b5f70d42d51a698a" title="Set the greatest distance from a sound at which the sound plays at full amplitude...">SetMinimumDistance</a> (<span class="keywordtype">float</span> distance) = 0;
<a name="l00145"></a>00145
<a name="l00151"></a>00151 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysSourceSoftware3D.html#ade044f239a6535a4926ab437d236848" title="Set the greatest distance from a sound at which the sound can be heard.">SetMaximumDistance</a> (<span class="keywordtype">float</span> distance) = 0;
<a name="l00152"></a>00152
<a name="l00157"></a>00157 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSndSysSourceSoftware3D.html#e454ca19b9c61840a5b81c010f2b217f" title="Retrieve the maximum distance for which a sound is heard at full volume.">GetMinimumDistance</a> () = 0;
<a name="l00158"></a>00158
<a name="l00163"></a>00163 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSndSysSourceSoftware3D.html#d1ea52a8b1056cf873ac46b89a2bb50e" title="Retrieve the maximum distance for which a sound can be heard.">GetMaximumDistance</a> () = 0;
<a name="l00164"></a>00164
<a name="l00166"></a>00166 <span class="comment">// virtual bool AttachFilter(csRef<iSound2Filter> filter) = 0;</span>
<a name="l00167"></a>00167
<a name="l00169"></a>00169 <span class="comment">// virtual bool RemoveFilter(csRef<iSound2Filter> filter)= 0;</span>
<a name="l00170"></a>00170 };
<a name="l00171"></a>00171
<a name="l00174"></a>00174 <span class="preprocessor">#endif // __CS_SNDSYS_ISNDSYS_SOURCE_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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2355
