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>FadeIn</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/SoundHandle/Overview.html">SoundHandle</a>::FadeIn</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHandle.h&gt;
14void FadeIn(
15     int frames
16);
17</pre>
18    </div>
19    <h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25            <th>Name</th>
26            <td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30          <td>in</td>
31          <th>frames</th>
32          <td>Number of elapsed frames during a fade-in.</td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">
37                None.
38               </div>
39    <h2>Description</h2>
40    <div class="section">
41      <p>Fades in the sound when playback starts.</p><p>If the handle is invalid, the function does nothing.</p><p>If fade-ins are specified with this function, they are configured to occur when <span><span><a href="../../../nw/snd/SoundArchivePlayer/Update.html">SoundArchivePlayer::Update</a></span></span> is called for the first time after <span><span><a href="../../../nw/snd/SoundStartable/StartSound.html">SoundArchivePlayer::StartSound</a></span></span> or <span><span><a href="../../../nw/snd/SequenceSoundHandle/StartPrepared.html">SoundHandle::StartPrepared</a></span></span> is used to start playback.</p><p>This function has no effect if it is called after sound playback has started and <span><span>SoundArchivePlayer::Update</span></span> has been called for the first time.</p><p>The volume control used for fade-in is also used for fade-out when playback stops.</p></div>
42    <h2>See Also</h2>
43    <div class="section">
44      <p class="reference"><a href="../../../nw/snd/SoundHandle/StartPrepared.html">StartPrepared</a><br /><a href="../../../nw/snd/SoundStartable/StartSound.html">SoundArchivePlayer::StartSound</a><br /> </p>
45    </div>
46    <h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/01/15</dt>
50        <dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>
56