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><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a>::ClearEffect</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundSystem.h&gt;
14static void ClearEffect(
15     <a href="../../../nw/snd/AuxBus.html">AuxBus</a> bus,
16     int fadeTimes = 0
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>bus</th>
33          <td>The effect bus.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>fadeTimes</th>
38          <td>Fade-out time (in milliseconds).</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">
43                None.
44               </div>
45    <h2>Description</h2>
46    <div class="section">
47      <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>
48    <h2>See Also</h2>
49    <div class="section">
50      <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>
51    </div>
52    <h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/06/16</dt>
56        <dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>
62