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    <title>SetParam</title>
8  </head>
9  <body>
10    <h1>nw::snd::FxReverb::SetParam Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_FxReverb.h&gt;
14
15bool SetParam(
16     const <a href="../../../nw/snd/FxReverb/Param/Overview.html">Param</a> & param
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>param</th>
33          <td>Reverb parameters.</td>
34        </tr> </table>
35    </div>
36    <h2>Return Values</h2>
37    <div class="section">Returns true if settings are successful. Returns false if settings fail (value out of bounds, for instance). </div>
38    <h2>Description</h2>
39    <div class="section">
40      <p>Sets reverb parameters.</p><p>The <a href="../../../nw/snd/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a> function calculates the memory size required based on the reverb parameters that have been set.</p><p>The <a href="../../../nw/snd/FxReverb/Param/Overview.html">Param</a> structure that has been set is copied internally.</p><p>Behavior changes before and after calling <a href="../../../nw/snd/SoundSystem/AppendEffect.html">SoundSystem::AppendEffect</a> and passing an instance of <a href="../../../nw/snd/FxReverb/Overview.html">FxReverb</a>.</p><p>Before calling <a href="../../../nw/snd/SoundSystem/AppendEffect.html">SoundSystem::AppendEffect</a>, a value range check is made for the m_Coloration, m_Damping, m_EarlyGain, and m_FusedGain members of the <a href="../../../nw/snd/FxReverb/Param/Overview.html">Param</a> structure. If values are out of range, execution stops on an assert for Debug and Development versions, while false is returned for Release versions.</p><p>After <a href="../../../nw/snd/SoundSystem/AppendEffect.html">SoundSystem::AppendEffect</a> is called, in addition to the value range check performed before the call, a check is made whether the required memory size has increased. In other words, if operations such as the following:<BR>- A value larger than when <a href="../../../nw/snd/FxReverb/Initialize.html">Initialize</a> was called is set for m_EarlyReflection<BR>- A value larger than when <a href="../../../nw/snd/FxReverb/Initialize.html">Initialize</a> was called is set for m_PreDelay<BR>- Value largers than when <a href="../../../nw/snd/FxReverb/Initialize.html">Initialize</a> was called are set for each member of m_pFilterSize<BR>- m_IsEnableSurrund is set to true even though it was set to false when <a href="../../../nw/snd/FxDelay/Initialize.html">Initialize</a> was called<BR> are performed, this function fails and returns false. If all of the conditions given above are satisfied, parameters can now be changed using <a href="../../../nw/snd/SoundSystem/AppendEffect.html">SoundSystem::AppendEffect</a>.</p></div>
41    <h2>See Also</h2>
42    <div class="section">
43      <p class="reference"><a href="../../../nw/snd/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a><br /><a href="../../../nw/snd/FxReverb/GetParam.html">GetParam</a><br /> </p>
44    </div>
45    <h2>Revision History</h2>
46    <div class="section">
47      <dl class="history">
48        <dt>2010/09/30</dt>
49        <dd>Added information on behavior before and after calling <a href="../../../nw/snd/SoundSystem/AppendEffect.html">SoundSystem::AppendEffect</a>.<br />
50        </dd>
51        <dt>2010/09/03</dt>
52        <dd>Added information about return values and behavior with Debug and Development versions.<BR>
53        </dd>
54        <dt>2010/07/07</dt>
55        <dd>Added to the description of the <a href="../../../nw/snd/FxReverb/Param/Overview.html">Param</a> structure set, and added <a href="../../../nw/snd/FxReverb/GetParam.html">GetParam</a> to See Also.
56        </dd>
57        <dt>2010/06/17</dt>
58        <dd>Initial version.<br />
59        </dd>
60      </dl>
61    </div>
62  <hr><p>CONFIDENTIAL</p></body>
63</html>