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::FxDelay</title> 51 </head> 52 <body> 53 <h1>nw::snd::FxDelay Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class FxDelay : public <a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>The delay 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> 61 <a name="struct" id="struct"> 62 <h2>Structures</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <th> 67 <a href="../../../nw/snd/FxDelay/Param/Overview.html">nw::snd::FxDelay::Param</a> 68 </th> 69 <td>A structure for delay parameters.</td> 70 </tr> </table> 71 </div> 72 </a> <a name="function" id="function"> 73 <h2>Member Functions</h2> 74 <div class="section"> 75 <table class="members"> 76 <tr> 77 <th class="category" colspan="3">Constructors and Destructors</th> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82 <a href="../../../nw/snd/FxDelay/FxDelay.html">FxDelay</a> 83 </th> 84 <td>Constructor.</td> 85 </tr> 86 <tr> 87 <td width="100"> <span class="virtual_style" title="virtual">V</span> 88 </td> 89 <th> 90 <a href="../../../nw/snd/FxDelay/~FxDelay.html">~FxDelay</a> 91 </th> 92 <td>Destructor.</td> 93 </tr> 94 <tr> 95 <th class="category" colspan="3">Effect</th> 96 </tr> 97 <tr> 98 <td width="100"> <span class="virtual_style" title="virtual">V</span> 99 </td> 100 <th> 101 <a href="../../../nw/snd/FxDelay/Initialize.html"><CODE>Initialize</CODE></a> 102 </th> 103 <td>Initializes the effect.</td> 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/FxDelay/Finalize.html"><CODE>Finalize</CODE></a> 110 </th> 111 <td>Stops 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/FxDelay/UpdateBuffer.html">UpdateBuffer</a> 118 </th> 119 <td>Performs effect processing.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <a href="../../../nw/snd/FxDelay/SetParam.html">SetParam</a> 125 </th> 126 <td>Sets delay parameters.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <a href="../../../nw/snd/FxDelay/GetParam.html">GetParam</a> 132 </th> 133 <td>Gets the delay parameter.</td> 134 </tr> 135 <tr> 136 <th class="category" colspan="3">Memory Allocation</th> 137 </tr> 138 <tr> 139 <td width="100"> </td> 140 <th> 141 <a href="../../../nw/snd/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a> 142 </th> 143 <td>Gets the memory size required by the reverb effect.</td> 144 </tr> 145 <tr> 146 <td width="100"> </td> 147 <th> 148 <a href="../../../nw/snd/FxDelay/AssignWorkBuffer.html">AssignWorkBuffer</a> 149 </th> 150 <td>Allocates memory to be used by the effect.</td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155 <a href="../../../nw/snd/FxDelay/ReleaseWorkBuffer.html">ReleaseWorkBuffer</a> 156 </th> 157 <td>Frees the memory that was used by the effect.</td> 158 </tr> </table> 159 </div> 160 </a> 161 <h2>Class Hierarchy</h2> 162 <div class="section"> 163 <p class="hierarchy"><a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a><br /> <b>nw::snd::FxDelay</b> 164 </p> 165 </div> 166 <h2>See Also</h2> 167 <div class="section"> 168 <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> 169 </div> 170 <h2>Revision History</h2> 171 <div class="section"> 172 <dl class="history"> 173 <dt>2010/09/03</dt> 174 <dd>Initial version.<br /> 175 </dd> 176 </dl> 177 </div> 178 <hr><p>CONFIDENTIAL</p></body> 179</html>