1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::snd::FxReverb</title> 51 </head> 52 <body> 53 <h1>nw::snd::FxReverb Class</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_FxReverb.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">class FxReverb : public <a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a></pre> 59 </div> 60 <h2>Description</h2> 61 <div class="section"> 62 <p>Reverb effect class.</p><p>For details on how to use effects, see the <a href="../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a> class.</p><p>Effects are processed by the CPU, not a DSP.</p></div> 63 <a name="struct" id="struct"> 64 <h2>Structures</h2> 65 <div class="section"> 66 <table class="members"> 67 <tr> 68 <th> 69 <a href="../../../nw/snd/FxReverb/FilterSize/Overview.html">nw::snd::FxReverb::FilterSize</a> 70 </th> 71 <td>This structure represents the filter size.</td> 72 </tr> 73 <tr> 74 <th> 75 <a href="../../../nw/snd/FxReverb/Param/Overview.html">nw::snd::FxReverb::Param</a> 76 </th> 77 <td>The data structure for reverb parameters.</td> 78 </tr> </table> 79 </div> 80 </a> <a name="function" id="function"> 81 <h2>Member Functions</h2> 82 <div class="section"> 83 <table class="members"> 84 <tr> 85 <th class="category" colspan="3">Constructors/Destructors</th> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90 <a href="../../../nw/snd/FxReverb/FxReverb.html">FxReverb</a> 91 </th> 92 <td>Constructor.</td> 93 </tr> 94 <tr> 95 <td width="100"> <span class="virtual_style" title="virtual">V</span> 96 </td> 97 <th> 98 <a href="../../../nw/snd/FxReverb/~FxReverb.html">~FxReverb</a> 99 </th> 100 <td>Destructor.</td> 101 </tr> 102 <tr> 103 <th class="category" colspan="3">Effect</th> 104 </tr> 105 <tr> 106 <td width="100"> <span class="virtual_style" title="virtual">V</span> 107 </td> 108 <th> 109 <a href="../../../nw/snd/FxReverb/Initialize.html"><CODE>Initialize</CODE></a> 110 </th> 111 <td>Initializes the effect.</td> 112 </tr> 113 <tr> 114 <td width="100"> <span class="virtual_style" title="virtual">V</span> 115 </td> 116 <th> 117 <a href="../../../nw/snd/FxReverb/Finalize.html"><CODE>Finalize</CODE></a> 118 </th> 119 <td>Stops the effect.</td> 120 </tr> 121 <tr> 122 <td width="100"> <span class="virtual_style" title="virtual">V</span> 123 </td> 124 <th> 125 <a href="../../../nw/snd/FxReverb/UpdateBuffer.html">UpdateBuffer</a> 126 </th> 127 <td>Performs effect processing.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132 <a href="../../../nw/snd/FxReverb/SetParam.html">SetParam</a> 133 </th> 134 <td>Sets reverb parameters.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139 <a href="../../../nw/snd/FxReverb/GetParam.html">GetParam</a> 140 </th> 141 <td>Gets reverb parameters.</td> 142 </tr> 143 <tr> 144 <th class="category" colspan="3">Memory Allocation</th> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <a href="../../../nw/snd/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a> 150 </th> 151 <td>Gets the memory size required by the reverb effect.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156 <a href="../../../nw/snd/FxReverb/AssignWorkBuffer.html">AssignWorkBuffer</a> 157 </th> 158 <td>Allocates memory to be used by the effect.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163 <a href="../../../nw/snd/FxReverb/ReleaseWorkBuffer.html">ReleaseWorkBuffer</a> 164 </th> 165 <td>Frees the memory that was used by the effect.</td> 166 </tr> </table> 167 </div> 168 </a> 169 <h2>Class Hierarchy</h2> 170 <div class="section"> 171 <p class="hierarchy"><a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a><br /> <b>nw::snd::FxReverb</b> 172 </p> 173 </div> 174 <h2>See Also</h2> 175 <div class="section"> 176 <p class="reference"><a href="../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a> class<br /><a href="../../../nw/snd/FxBase/Overview.html">FxBase</a> class<br /> </p> 177 </div> 178 <h2>Revision History</h2> 179 <div class="section"> 180 <dl class="history"> 181 <dt>2010/08/25</dt> 182 <dd>Added the fact that effects are processed by the CPU.<BR> 183 </dd> 184 <dt>2010/07/07</dt> 185 <dd>Added <a href="../../../nw/snd/FxReverb/GetParam.html">GetParam</a>.<br /> 186 </dd> 187 <dt>2010/06/17</dt> 188 <dd>Initial version.<br /> 189 </dd> 190 </dl> 191 </div> 192 <hr><p>CONFIDENTIAL</p></body> 193</html>