Sophie

Sophie

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

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: isndsys/ss_renderer.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>isndsys/ss_renderer.h</h1><a href="ss__renderer_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_RENDERER_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SNDSYS_RENDERER_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="ss__filter_8h.html" title="Sound system: software filters.">isndsys/ss_filter.h</a>"</span>
<a name="l00029"></a>00029 
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiSndSysData.html" title="The sound data is an interface to the container object controlling raw sound data...">iSndSysData</a>;
<a name="l00035"></a>00035 <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="l00036"></a>00036 <span class="keyword">struct </span><a class="code" href="structiSndSysSource.html">iSndSysSource</a>;
<a name="l00037"></a>00037 <span class="keyword">struct </span><a class="code" href="structiSndSysListener.html" title="The sound listener is a unique object created by the sound renderer.">iSndSysListener</a>;
<a name="l00038"></a>00038 <span class="keyword">struct </span><a class="code" href="structiSndSysRendererCallback.html" title="Sound System renderer interface for callback notification.">iSndSysRendererCallback</a>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef CS_SNDSYS_SOURCE_DISTANCE_INFINITE</span>
<a name="l00041"></a><a class="code" href="group__sndsys.html#g166882a13c2046e4baf3633479d7c229">00041</a> <span class="preprocessor"></span><span class="preprocessor">#define CS_SNDSYS_SOURCE_DISTANCE_INFINITE -1.0f</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a><a class="code" href="group__sndsys.html#gca656338c994f44004a2133324d0442a">00044</a> <span class="preprocessor">#define CS_SNDSYS_SOURCE_STOPPED    0</span>
<a name="l00045"></a><a class="code" href="group__sndsys.html#g752cd34a8060cbf8e156bb6733470a47">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define CS_SNDSYS_SOURCE_PLAYING    1</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 
<a name="l00054"></a><a class="code" href="structiSndSysRenderer.html">00054</a> <span class="keyword">struct </span><a class="code" href="structiSndSysRenderer.html">iSndSysRenderer</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="l00055"></a>00055 {
<a name="l00057"></a>00057   <a class="code" href="structiSndSysRenderer.html#a62ab26e557a4c62ec04c05d1047b51e" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysRenderer.html">iSndSysRenderer</a>,0,2,1);
<a name="l00058"></a>00058 
<a name="l00060"></a>00060   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysRenderer.html#62dc3ec887849261e9960074e227fcc9" title="Set Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).">SetVolume</a> (<span class="keywordtype">float</span> vol) = 0;
<a name="l00061"></a>00061 
<a name="l00063"></a>00063   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiSndSysRenderer.html#d354568adb94ea5083376df6ee11e4ba" title="Get Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).">GetVolume</a> () = 0;
<a name="l00064"></a>00064 
<a name="l00069"></a>00069   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iSndSysStream&gt;</a> <a class="code" href="structiSndSysRenderer.html#caa268b09a9445c2aba0930f77daadf9" title="Uses the provided iSound2Data to create a sound stream with the given 3D rendering...">CreateStream</a>(<a class="code" href="structiSndSysData.html" title="The sound data is an interface to the container object controlling raw sound data...">iSndSysData</a>* data,
<a name="l00070"></a>00070         <span class="keywordtype">int</span> mode3d) = 0;
<a name="l00071"></a>00071 
<a name="l00073"></a>00073   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iSndSysSource&gt;</a> <a class="code" href="structiSndSysRenderer.html#ed2a7ceb2d9091aadb5ad08071d368bc" title="Creates a source when provided with a Sound Stream.">CreateSource</a>(<a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a>* stream) = 0;
<a name="l00074"></a>00074 
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRenderer.html#f46d2b033aed3104f6b5ee9d6b64b087" title="Remove a stream from the sound renderer&amp;#39;s list of streams.">RemoveStream</a>(<a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a>* stream) = 0;
<a name="l00077"></a>00077 
<a name="l00079"></a>00079   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRenderer.html#cfaa253caefe3d28d97e8b57467c2da9" title="Remove a source from the sound renderer&amp;#39;s list of sources.">RemoveSource</a>(<a class="code" href="structiSndSysSource.html">iSndSysSource</a>* source) = 0;
<a name="l00080"></a>00080 
<a name="l00082"></a>00082   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iSndSysListener&gt;</a> <a class="code" href="structiSndSysRenderer.html#873692ff926d7a5f0cc7907362fd4813" title="Get the global Listener object.">GetListener</a> () = 0;
<a name="l00083"></a>00083 
<a name="l00085"></a>00085   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRenderer.html#2f23d0dafcf994412d42238a7d4fd9d8" title="Register a component to receive notification of renderer events.">RegisterCallback</a>(<a class="code" href="structiSndSysRendererCallback.html" title="Sound System renderer interface for callback notification.">iSndSysRendererCallback</a> *pCallback) = 0;
<a name="l00086"></a>00086 
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRenderer.html#9bf657f5ecd724dca5272ed1ff56e2ed" title="Unregister a previously registered callback component.">UnregisterCallback</a>(<a class="code" href="structiSndSysRendererCallback.html" title="Sound System renderer interface for callback notification.">iSndSysRendererCallback</a> *pCallback) = 0;
<a name="l00089"></a>00089 };
<a name="l00090"></a>00090 
<a name="l00092"></a>00092 <span class="comment">//</span>
<a name="l00093"></a>00093 <span class="comment">//  A component wishing to receive notification of Sound Renderer events</span>
<a name="l00094"></a>00094 <span class="comment">//  should implement this interface, and call iSndSysRenderer::RegisterCallback()</span>
<a name="l00095"></a>00095 <span class="comment">//  to register with the renderer.</span>
<a name="l00096"></a>00096 <span class="comment">//</span>
<a name="l00097"></a><a class="code" href="structiSndSysRendererCallback.html">00097</a> <span class="keyword">struct </span><a class="code" href="structiSndSysRendererCallback.html" title="Sound System renderer interface for callback notification.">iSndSysRendererCallback</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="l00098"></a>00098 {
<a name="l00100"></a>00100   <a class="code" href="structiSndSysRendererCallback.html#2e6126070874e2583589bbc1f157d664" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysRendererCallback.html" title="Sound System renderer interface for callback notification.">iSndSysRendererCallback</a>,0,1,0);
<a name="l00101"></a>00101 
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysRendererCallback.html#133217a4f00122b82126841e80adabdb" title="Called whenever a stream is added to the system.">StreamAddNotification</a>(<a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a> *pStream) = 0;
<a name="l00104"></a>00104 
<a name="l00106"></a>00106   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysRendererCallback.html#8d76a0cd9aed3ff15737555199f4641b" title="Called whenever a stream is removed from the system.">StreamRemoveNotification</a>(<a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a> *pStream) = 0;
<a name="l00107"></a>00107 
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysRendererCallback.html#b0ce2560be7efd19b583f083bc1869cd" title="Called whenever a source is added to the system.">SourceAddNotification</a>(<a class="code" href="structiSndSysSource.html">iSndSysSource</a> *pSource) = 0;
<a name="l00110"></a>00110 
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiSndSysRendererCallback.html#f6808f7b7675bb9676281f0f274c81b5" title="Called whenever a source is removed to the system.">SourceRemoveNotification</a>(<a class="code" href="structiSndSysSource.html">iSndSysSource</a> *pSource) = 0;
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 
<a name="l00118"></a><a class="code" href="structiSndSysRendererSoftware.html">00118</a> <span class="keyword">struct </span><a class="code" href="structiSndSysRendererSoftware.html" title="Software renderer specific interface extensions.">iSndSysRendererSoftware</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="l00119"></a>00119 {
<a name="l00121"></a>00121   <a class="code" href="structiSndSysRendererSoftware.html#a4a33a574fd8640fbf06c3c29fb2ba0c" title="SCF2006 - See http://www.crystalspace3d.org/cseps/csep-0010.html.">SCF_INTERFACE</a>(<a class="code" href="structiSndSysRendererSoftware.html" title="Software renderer specific interface extensions.">iSndSysRendererSoftware</a>,0,1,1);
<a name="l00122"></a>00122 
<a name="l00124"></a>00124   <span class="comment">//  Output filters can only receive sound data and cannot modify it.  They will receive data</span>
<a name="l00125"></a>00125   <span class="comment">//   from the same thread that the CS event handler executes in, once per frame.</span>
<a name="l00126"></a>00126   <span class="comment">//</span>
<a name="l00127"></a>00127   <span class="comment">//  Valid Locations:  SS_FILTER_LOC_RENDEROUT</span>
<a name="l00128"></a>00128   <span class="comment">//  </span>
<a name="l00129"></a>00129   <span class="comment">//  Returns FALSE if the filter could not be added.</span>
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRendererSoftware.html#0f4001a45bdd517080679a084355edf9" 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="l00131"></a>00131 
<a name="l00133"></a>00133   <span class="comment">//</span>
<a name="l00134"></a>00134   <span class="comment">//  Valid Locations:  SS_FILTER_LOC_RENDEROUT</span>
<a name="l00135"></a>00135   <span class="comment">//</span>
<a name="l00136"></a>00136   <span class="comment">// Returns FALSE if the filter is not in the list at the time of the call.</span>
<a name="l00137"></a>00137   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiSndSysRendererSoftware.html#1946cb5d31f51875dfe6ea9fcaeceeff" 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="l00138"></a>00138 };
<a name="l00139"></a>00139 
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 
<a name="l00144"></a>00144 <span class="preprocessor">#endif // __CS_SNDSYS_RENDERER_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