<!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: iSndSysRenderer 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>iSndSysRenderer Struct Reference<br>
<small>
[<a class="el" href="group__sndsys.html">Sound system</a>]</small>
</h1><!-- doxytag: class="iSndSysRenderer" --><!-- doxytag: inherits="iBase" --><code>#include <<a class="el" href="ss__renderer_8h-source.html">isndsys/ss_renderer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSndSysRenderer:</div>
<div class="dynsection">
<p><center><img src="structiSndSysRenderer__inherit__graph.png" border="0" usemap="#iSndSysRenderer__inherit__map" alt="Inheritance graph"></center>
<map name="iSndSysRenderer__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="44,7,100,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSndSysRenderer-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 <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiSndSysSource.html">iSndSysSource</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#ed2a7ceb2d9091aadb5ad08071d368bc">CreateSource</a> (<a class="el" href="structiSndSysStream.html">iSndSysStream</a> *stream)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a source when provided with a Sound Stream. <a href="#ed2a7ceb2d9091aadb5ad08071d368bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiSndSysStream.html">iSndSysStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#caa268b09a9445c2aba0930f77daadf9">CreateStream</a> (<a class="el" href="structiSndSysData.html">iSndSysData</a> *data, int mode3d)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses the provided iSound2Data to create a sound stream with the given 3D rendering mode. <a href="#caa268b09a9445c2aba0930f77daadf9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiSndSysListener.html">iSndSysListener</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#873692ff926d7a5f0cc7907362fd4813">GetListener</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global Listener object. <a href="#873692ff926d7a5f0cc7907362fd4813"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#d354568adb94ea5083376df6ee11e4ba">GetVolume</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud). <a href="#d354568adb94ea5083376df6ee11e4ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#2f23d0dafcf994412d42238a7d4fd9d8">RegisterCallback</a> (<a class="el" href="structiSndSysRendererCallback.html">iSndSysRendererCallback</a> *pCallback)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a component to receive notification of renderer events. <a href="#2f23d0dafcf994412d42238a7d4fd9d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#cfaa253caefe3d28d97e8b57467c2da9">RemoveSource</a> (<a class="el" href="structiSndSysSource.html">iSndSysSource</a> *source)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a source from the sound renderer's list of sources. <a href="#cfaa253caefe3d28d97e8b57467c2da9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#f46d2b033aed3104f6b5ee9d6b64b087">RemoveStream</a> (<a class="el" href="structiSndSysStream.html">iSndSysStream</a> *stream)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a stream from the sound renderer's list of streams. <a href="#f46d2b033aed3104f6b5ee9d6b64b087"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#a62ab26e557a4c62ec04c05d1047b51e">SCF_INTERFACE</a> (<a class="el" href="structiSndSysRenderer.html">iSndSysRenderer</a>, 0, 2, 1)</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="#a62ab26e557a4c62ec04c05d1047b51e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#62dc3ec887849261e9960074e227fcc9">SetVolume</a> (float vol)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud). <a href="#62dc3ec887849261e9960074e227fcc9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html#9bf657f5ecd724dca5272ed1ff56e2ed">UnregisterCallback</a> (<a class="el" href="structiSndSysRendererCallback.html">iSndSysRendererCallback</a> *pCallback)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously registered callback component. <a href="#9bf657f5ecd724dca5272ed1ff56e2ed"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b><a class="el" href="todo.html#_todo000023">Todo:</a></b></dt><dd>Document me! <p>
Should Sound Streams get processing time even if no Sound Sources are attached? </dd></dl>
<p>Definition at line <a class="el" href="ss__renderer_8h-source.html#l00054">54</a> of file <a class="el" href="ss__renderer_8h-source.html">ss_renderer.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ed2a7ceb2d9091aadb5ad08071d368bc"></a><!-- doxytag: member="iSndSysRenderer::CreateSource" ref="ed2a7ceb2d9091aadb5ad08071d368bc" args="(iSndSysStream *stream)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiSndSysSource.html">iSndSysSource</a>> iSndSysRenderer::CreateSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysStream.html">iSndSysStream</a> * </td>
<td class="paramname"> <em>stream</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a source when provided with a Sound Stream.
<p>
</div>
</div><p>
<a class="anchor" name="caa268b09a9445c2aba0930f77daadf9"></a><!-- doxytag: member="iSndSysRenderer::CreateStream" ref="caa268b09a9445c2aba0930f77daadf9" args="(iSndSysData *data, int mode3d)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiSndSysStream.html">iSndSysStream</a>> iSndSysRenderer::CreateStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysData.html">iSndSysData</a> * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mode3d</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uses the provided iSound2Data to create a sound stream with the given 3D rendering mode.
<p>
</div>
</div><p>
<a class="anchor" name="873692ff926d7a5f0cc7907362fd4813"></a><!-- doxytag: member="iSndSysRenderer::GetListener" ref="873692ff926d7a5f0cc7907362fd4813" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiSndSysListener.html">iSndSysListener</a>> iSndSysRenderer::GetListener </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the global Listener object.
<p>
</div>
</div><p>
<a class="anchor" name="d354568adb94ea5083376df6ee11e4ba"></a><!-- doxytag: member="iSndSysRenderer::GetVolume" ref="d354568adb94ea5083376df6ee11e4ba" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iSndSysRenderer::GetVolume </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).
<p>
</div>
</div><p>
<a class="anchor" name="2f23d0dafcf994412d42238a7d4fd9d8"></a><!-- doxytag: member="iSndSysRenderer::RegisterCallback" ref="2f23d0dafcf994412d42238a7d4fd9d8" args="(iSndSysRendererCallback *pCallback)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSndSysRenderer::RegisterCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysRendererCallback.html">iSndSysRendererCallback</a> * </td>
<td class="paramname"> <em>pCallback</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a component to receive notification of renderer events.
<p>
</div>
</div><p>
<a class="anchor" name="cfaa253caefe3d28d97e8b57467c2da9"></a><!-- doxytag: member="iSndSysRenderer::RemoveSource" ref="cfaa253caefe3d28d97e8b57467c2da9" args="(iSndSysSource *source)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSndSysRenderer::RemoveSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysSource.html">iSndSysSource</a> * </td>
<td class="paramname"> <em>source</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a source from the sound renderer's list of sources.
<p>
</div>
</div><p>
<a class="anchor" name="f46d2b033aed3104f6b5ee9d6b64b087"></a><!-- doxytag: member="iSndSysRenderer::RemoveStream" ref="f46d2b033aed3104f6b5ee9d6b64b087" args="(iSndSysStream *stream)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSndSysRenderer::RemoveStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysStream.html">iSndSysStream</a> * </td>
<td class="paramname"> <em>stream</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a stream from the sound renderer's list of streams.
<p>
</div>
</div><p>
<a class="anchor" name="a62ab26e557a4c62ec04c05d1047b51e"></a><!-- doxytag: member="iSndSysRenderer::SCF_INTERFACE" ref="a62ab26e557a4c62ec04c05d1047b51e" args="(iSndSysRenderer, 0, 2, 1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">iSndSysRenderer::SCF_INTERFACE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysRenderer.html">iSndSysRenderer</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">2 </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">1 </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>
<a class="anchor" name="62dc3ec887849261e9960074e227fcc9"></a><!-- doxytag: member="iSndSysRenderer::SetVolume" ref="62dc3ec887849261e9960074e227fcc9" args="(float vol)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysRenderer::SetVolume </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>vol</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set Volume (range 0.0 = silence 1.0 = as provided 2.0 = twice as loud).
<p>
</div>
</div><p>
<a class="anchor" name="9bf657f5ecd724dca5272ed1ff56e2ed"></a><!-- doxytag: member="iSndSysRenderer::UnregisterCallback" ref="9bf657f5ecd724dca5272ed1ff56e2ed" args="(iSndSysRendererCallback *pCallback)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSndSysRenderer::UnregisterCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysRendererCallback.html">iSndSysRendererCallback</a> * </td>
<td class="paramname"> <em>pCallback</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unregister a previously registered callback component.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>isndsys/<a class="el" href="ss__renderer_8h-source.html">ss_renderer.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
>
3730
