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 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::snd::FxDelay</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::FxDelay</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class FxDelay : public <a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a></pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <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> 59 <a name="struct" id="struct"> 60 <h2>Structures</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <th> 65 <a href="../../../nw/snd/FxDelay/Param/Overview.html">nw::snd::FxDelay::Param</a> 66 </th> 67 <td>A structure for delay parameters.</td> 68 </tr> </table> 69 </div> 70 </a> <a name="function" id="function"> 71 <h2>Member Functions</h2> 72 <div class="section"> 73 <table class="members"> 74 <tr> 75 <th class="category" colspan="3">Constructors and Destructors</th> 76 </tr> 77 <tr> 78 <td width="100"> </td> 79 <th> 80 <a href="../../../nw/snd/FxDelay/FxDelay.html">FxDelay</a> 81 </th> 82 <td>Constructor.</td> 83 </tr> 84 <tr> 85 <td width="100"> <span class="virtual_style" title="virtual">V</span> 86 </td> 87 <th> 88 <a href="../../../nw/snd/FxDelay/~FxDelay.html">~FxDelay</a> 89 </th> 90 <td>Destructor.</td> 91 </tr> 92 <tr> 93 <th class="category" colspan="3">Effect</th> 94 </tr> 95 <tr> 96 <td width="100"> <span class="virtual_style" title="virtual">V</span> 97 </td> 98 <th> 99 <a href="../../../nw/snd/FxDelay/Initialize.html"><CODE>Initialize</CODE></a> 100 </th> 101 <td>Initializes the effect.</td> 102 </tr> 103 <tr> 104 <td width="100"> <span class="virtual_style" title="virtual">V</span> 105 </td> 106 <th> 107 <a href="../../../nw/snd/FxDelay/Finalize.html">Finalize</a> 108 </th> 109 <td>Stops the effect.</td> 110 </tr> 111 <tr> 112 <td width="100"> <span class="virtual_style" title="virtual">V</span> 113 </td> 114 <th> 115 <a href="../../../nw/snd/FxDelay/UpdateBuffer.html">UpdateBuffer</a> 116 </th> 117 <td>Performs effect processing.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122 <a href="../../../nw/snd/FxDelay/SetParam.html">SetParam</a> 123 </th> 124 <td>Sets delay parameters.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129 <a href="../../../nw/snd/FxDelay/GetParam.html">GetParam</a> 130 </th> 131 <td>Gets the delay parameter.</td> 132 </tr> 133 <tr> 134 <th class="category" colspan="3">Memory Allocation</th> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139 <a href="../../../nw/snd/FxDelay/GetRequiredMemSize.html">GetRequiredMemSize</a> 140 </th> 141 <td>Gets the memory size required by the reverb effect.</td> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146 <a href="../../../nw/snd/FxDelay/AssignWorkBuffer.html">AssignWorkBuffer</a> 147 </th> 148 <td>Allocates memory to be used by the effect.</td> 149 </tr> 150 <tr> 151 <td width="100"> </td> 152 <th> 153 <a href="../../../nw/snd/FxDelay/ReleaseWorkBuffer.html">ReleaseWorkBuffer</a> 154 </th> 155 <td>Frees the memory that was used by the effect.</td> 156 </tr> </table> 157 </div> 158 </a> 159 <h2>Class Hierarchy</h2> 160 <div class="section"> 161 <p class="hierarchy"><a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a><br /> <b>nw::snd::FxDelay</b> 162 </p> 163 </div> 164 <h2>See Also</h2> 165 <div class="section"> 166 <p class="reference"><CODE><a href="../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a></CODE> class<br /><CODE><a href="../../../nw/snd/FxBase/Overview.html">FxBase</a></CODE> class<br /> </p> 167 </div> 168 <h2>Revision History</h2> 169 <div class="section"> 170 <dl class="history"> 171 <dt>2010/09/03</dt> 172 <dd>Initial version.<br /> 173 </dd> 174 </dl> 175 </div> 176 <hr><p>CONFIDENTIAL</p></body> 177</html> 178