aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03862.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a03862.html348
1 files changed, 348 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03862.html b/docs/doxygen/nel/a03862.html
new file mode 100644
index 00000000..00510b86
--- /dev/null
+++ b/docs/doxygen/nel/a03862.html
@@ -0,0 +1,348 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NLSOUND::ILoader class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLSOUND::ILoader Class Reference</h1><code>#include &lt;<a class="el" href="a05928.html">loader.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Sound loader interface <p>
+<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd></dd></dl>
+In order to fill a static buffer, just call <a class="el" href="a03862.html#NLSOUND_1_1ILoadera0">fillBuffer()</a>. In order to stream into a buffer, call <a class="el" href="a03862.html#NLSOUND_1_1ILoadera1">fillBufferPart()</a> several times.<p>
+<dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05928.html#l00049">49</a> of file <a class="el" href="a05928.html">loader.h</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>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera0">fillBuffer</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills the buffer entirely. <a href="#NLSOUND_1_1ILoadera0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera1">fillBufferPart</a> (<a class="el" href="a04558.html#a11">uint32</a> <a class="el" href="a04223.html#a587">size</a>)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera2">getSize</a> ()=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the size of the data to load (or MAXINT32 if unknown). <a href="#NLSOUND_1_1ILoadera2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera3">ILoader</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1ILoadera3"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera4">setBuffer</a> (<a class="el" href="a02298.html">IBuffer</a> *<a class="el" href="a04223.html#a589">buffer</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the destination buffer. <a href="#NLSOUND_1_1ILoadera4"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoadera5">~ILoader</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1ILoadera5"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData</a> (<a class="el" href="a04558.html#a11">uint32</a> <a class="el" href="a04223.html#a587">size</a>)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provide data (load). <a href="#NLSOUND_1_1ILoaderb0"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02298.html">IBuffer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1ILoadera3" doxytag="NLSOUND::ILoader::ILoader" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLSOUND::ILoader::ILoader </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05928.html#l00069">69</a> of file <a class="el" href="a05928.html">loader.h</a>.
+<p>
+<div class="fragment"><pre>00069 : <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>(NULL) {}
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1ILoadera5" doxytag="NLSOUND::ILoader::~ILoader" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual NLSOUND::ILoader::~<a class="el" href="a03862.html">ILoader</a> </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Destructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05928.html#l00072">72</a> of file <a class="el" href="a05928.html">loader.h</a>.
+<p>
+<div class="fragment"><pre>00072 { <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a> = NULL; }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1ILoadera0" doxytag="NLSOUND::ILoader::fillBuffer" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NLSOUND::ILoader::fillBuffer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Fills the buffer entirely.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05927.html#l00066">66</a> of file <a class="el" href="a05927.html">loader.cpp</a>.
+<p>
+References <a class="el" href="a02298.html#NLSOUND_1_1IBuffera0">NLSOUND::IBuffer::fillBuffer()</a>, <a class="el" href="a03862.html#NLSOUND_1_1ILoadera2">getSize()</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData()</a>, <a class="el" href="a05646.html#l00645">size</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
+<p>
+<div class="fragment"><pre>00067 {
+00068 <a class="code" href="a04199.html#a6">nlassert</a>( _Buffer != NULL );
+00069 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a587">size</a> = <a class="code" href="a03862.html#NLSOUND_1_1ILoadera2">getSize</a>();
+00070 <span class="keywordflow">return</span> <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>-&gt;fillBuffer( <a class="code" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData</a>( size ), size );
+00071 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1ILoadera1" doxytag="NLSOUND::ILoader::fillBufferPart" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> bool NLSOUND::ILoader::fillBufferPart </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a11">uint32</a>&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>size</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Fill the buffer up to the specified size, calling fillMore() if the buffer supports it, otherwise, fills the buffer entirely, calling <a class="el" href="a02298.html#NLSOUND_1_1IBuffera0">IBuffer::fillBuffer()</a>
+<p>
+Definition at line <a class="el" href="a05927.html#l00048">48</a> of file <a class="el" href="a05927.html">loader.cpp</a>.
+<p>
+References <a class="el" href="a02298.html#NLSOUND_1_1IBuffera0">NLSOUND::IBuffer::fillBuffer()</a>, <a class="el" href="a05517.html#l00079">NLSOUND::IBuffer::fillMore()</a>, <a class="el" href="a02298.html#NLSOUND_1_1IBuffera5">NLSOUND::IBuffer::getSize()</a>, <a class="el" href="a03862.html#NLSOUND_1_1ILoadera2">getSize()</a>, <a class="el" href="a02298.html#NLSOUND_1_1IBuffera7">NLSOUND::IBuffer::isFillMoreSupported()</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData()</a>, <a class="el" href="a05646.html#l00645">size</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
+<p>
+<div class="fragment"><pre>00049 {
+00050 <a class="code" href="a04199.html#a6">nlassert</a>( (_Buffer != NULL) &amp;&amp; (size&lt;=<a class="code" href="a03862.html#NLSOUND_1_1ILoadera2">getSize</a>()) );
+00051 <span class="keywordflow">if</span> ( <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>-&gt;isFillMoreSupported() )
+00052 {
+00053 <a class="code" href="a04199.html#a6">nlassert</a>( <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>-&gt;getSize() != 0 );
+00054 <span class="keywordflow">return</span> <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>-&gt;fillMore( <a class="code" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData</a>( size ), size );
+00055 }
+00056 <span class="keywordflow">else</span>
+00057 {
+00058 <span class="keywordflow">return</span> <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a>-&gt;fillBuffer( <a class="code" href="a03862.html#NLSOUND_1_1ILoaderb0">provideData</a>( size), size );
+00059 }
+00060 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1ILoadera2" doxytag="NLSOUND::ILoader::getSize" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a11">uint32</a> NLSOUND::ILoader::getSize </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return the size of the data to load (or MAXINT32 if unknown).
+<p>
+
+<p>
+Referenced by <a class="el" href="a05927.html#l00066">fillBuffer()</a>, and <a class="el" href="a05927.html#l00048">fillBufferPart()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1ILoaderb0" doxytag="NLSOUND::ILoader::provideData" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void* NLSOUND::ILoader::provideData </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a11">uint32</a>&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>size</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [protected, pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Provide data (load).
+<p>
+
+<p>
+Referenced by <a class="el" href="a05927.html#l00066">fillBuffer()</a>, and <a class="el" href="a05927.html#l00048">fillBufferPart()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1ILoadera4" doxytag="NLSOUND::ILoader::setBuffer" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLSOUND::ILoader::setBuffer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a02298.html">IBuffer</a> *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>buffer</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the destination buffer.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05927.html#l00037">37</a> of file <a class="el" href="a05927.html">loader.cpp</a>.
+<p>
+References <a class="el" href="a05646.html#l00649">buffer</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>.
+<p>
+<div class="fragment"><pre>00038 {
+00039 <a class="code" href="a04199.html#a6">nlassert</a>( buffer!=NULL );
+00040 <a class="code" href="a03862.html#NLSOUND_1_1ILoaderp0">_Buffer</a> = <a class="code" href="a04223.html#a589">buffer</a>;
+00041 }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1ILoaderp0" doxytag="NLSOUND::ILoader::_Buffer" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="a02298.html">IBuffer</a>* <a class="el" href="a03862.html#NLSOUND_1_1ILoaderp0">NLSOUND::ILoader::_Buffer</a><code> [protected]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05928.html#l00081">81</a> of file <a class="el" href="a05928.html">loader.h</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="a05928.html">loader.h</a><li><a class="el" href="a05927.html">loader.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:51:29 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>