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>ClearEffect</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundSystem::ClearEffect Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundSystem.h&gt;
14
15static void ClearEffect(
16     <a href="../../../nw/snd/AuxBus.html">AuxBus</a> bus,
17     int fadeTimes = 0
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>in</td>
33          <th>bus</th>
34          <td>The effect bus.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>fadeTimes</th>
39          <td>Fade-out time (in milliseconds).</td>
40        </tr> </table>
41    </div>
42    <h2>Return Values</h2>
43    <div class="section">
44                None.
45               </div>
46    <h2>Description</h2>
47    <div class="section">
48      <p>Deletes from the bus all effects registered to the specified AUX bus.</p><p>A fade-out can be applied when closing the effect using fadeTimes. The effect will not close until the fade-out completes. To find out whether the fade-out has completed, call <a href="../../../nw/snd/SoundSystem/IsFinishedClearEffect.html">nw::snd::SoundSystem::IsFinishedClearEffect</a>.</p><p><a href="../../../nw/snd/FxBase/Finalize.html">nw::snd::FxBase::Finalize</a> is called internally when deleting an effect from the bus.</p></div>
49    <h2>See Also</h2>
50    <div class="section">
51      <p class="reference"><a href="../../../nw/snd/SoundSystem/IsFinishedClearEffect.html">IsFinishedClearEffect</a><br /><a href="../../../nw/snd/AuxBus.html">AuxBus</a><br /><a href="../../../nw/snd/FxBase/Overview.html">FxBase</a><br /> </p>
52    </div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/06/16</dt>
57        <dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>