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>nn::snd::CTR::FxReverb</title>
51  </head>
52  <body>
53<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/snd/Overview.html">snd</a>::<a href="../../../../nn/snd/CTR/Overview.html">CTR</a>::FxReverb</CODE> Class</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class FxReverb</pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>The reverb effect class.</p><p>Call the <CODE><a href="../../../../nn/snd/CTR/SetEffect.html">SetEffect</a></CODE> function to execute an effect.</p><p>Effects are processed in the CPU (not in the DSP).</p><p>Unlike <a href="../../../../nn/snd/CTR/FxDelay/Overview.html"><CODE>FxDelay</CODE></a>, effects are only processed in the front two channels.</p><p>
61Up to CTR-SDK 3.1, there was a damping bug that caused reverb effects to feel weaker than they actually were. In CTR-SDK 3.2, <CODE>m_IsEnableDampingBugFix</CODE> was added to the <a href="../../../../nn/snd/CTR/FxReverb/Param/Overview.html"><CODE>nn::snd::CTR::FxReverb::Param</CODE></a> structure. When this variable is <CODE>true</CODE>, the original effect can be achieved. The default value for <CODE>m_IsEnableDampingBugFix</CODE> is currently <CODE>false</CODE>. (In other words, compatibility was taken seriously: the bug is included and behavior is the same as before.) In a future major update of CTR-SDK we plan to fix this bug and possibly even remove <CODE>m_IsEnableDampingBugFix</CODE>.
62      </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="../../../../nn/snd/CTR/FxReverb/FilterSize/Overview.html">nn::snd::CTR::FxReverb::FilterSize</a>
70            </th>
71<td>This structure represents a filter size.</td>
72          </tr>
73          <tr>
74            <th>
75<a href="../../../../nn/snd/CTR/FxReverb/Param/Overview.html">nn::snd::CTR::FxReverb::Param</a>
76            </th>
77<td>The 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="../../../../nn/snd/CTR/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="../../../../nn/snd/CTR/FxReverb/~FxReverb.html">~FxReverb</a>
99            </th>
100<td>Destructor.</td>
101          </tr>
102          <tr>
103<th class="category" colspan="3">Setting, Getting Parameters</th>
104          </tr>
105          <tr>
106            <td width="100">  </td>
107            <th>
108<a href="../../../../nn/snd/CTR/FxReverb/SetParam.html">SetParam</a>
109            </th>
110<td>Configures the reverb parameters.</td>
111          </tr>
112          <tr>
113            <td width="100">  </td>
114            <th>
115<a href="../../../../nn/snd/CTR/FxReverb/GetParam.html">GetParam</a>
116            </th>
117<td>Gets the reverb parameters.</td>
118          </tr>
119          <tr>
120<th class="category" colspan="3">Memory Allocation</th>
121          </tr>
122          <tr>
123            <td width="100">  </td>
124            <th>
125<a href="../../../../nn/snd/CTR/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a>
126            </th>
127<td>Gets the memory size required for an effect.</td>
128          </tr>
129          <tr>
130            <td width="100">  </td>
131            <th>
132<a href="../../../../nn/snd/CTR/FxReverb/AssignWorkBuffer.html">AssignWorkBuffer</a>
133            </th>
134<td>Allocates a memory region to be used by the effect.</td>
135          </tr>
136          <tr>
137            <td width="100">  </td>
138            <th>
139<a href="../../../../nn/snd/CTR/FxReverb/ReleaseWorkBuffer.html">ReleaseWorkBuffer</a>
140            </th>
141<td>Deallocates the memory region that was used by the effect.</td>
142          </tr> </table>
143      </div>
144    </a>
145<h2>See Also</h2>
146    <div class="section">
147<p class="reference"><a href="../../../../nn/snd/CTR/FxDelay/Overview.html">FxDelay</a> Class<br /> </p>
148    </div>
149<h2>Revision History</h2>
150    <div class="section">
151      <dl class="history">
152        <dt>2011/09/13</dt>
153<dd>Added information about a damping bug.
154        </dd>
155        <dt>2010/11/10</dt>
156<dd>Initial version.<br />
157        </dd>
158      </dl>
159    </div>
160  <hr><p>CONFIDENTIAL</p></body>
161</html>