1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>
2<head>
3<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
4<title>SND_SetTrackModDepth</title>
5<link rel="stylesheet" href="../css/nitro.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
7</head>
8<body>
9<div class="refentry" lang="ja"><a name="IDAFLWT"></a><div class="titlepage">
10<div></div>
11<div></div>
12</div>
13<h1>SND_SetTrackModDepth <IMG src="../image/NTR.gif" width="24" height="12" border="0" align=middle><IMG src="../image/TWL.gif" width="24" height="12" border="0" align=middle></h1>
14<h2>Syntax</h2>
15<dl>
16<dd><pre class="funcsynopsisinfo"><code>#include &lt;nitro/snd.h&gt;</code></pre></dd>
17<dd><pre class="funcprototype"><code class="funcprototype">void SND_SetTrackModDepth(
18        int <var>playerNo</var>,
19        u32 <var>trackBitMask</var>,
20        int <var>depth</var> );</code><br></pre></dd>
21</dl>
22<div class="refsection" lang="ja"><a name="IDACNWT"></a>
23      <h2>Arguments</h2>
24
25      <div class="variablelist">
26<table border="0">
27<col align="left" valign="top">
28<tbody>
29<tr>
30<td><em><strong><code>playerNo</code></strong></em></td>
31<td>The player number. Takes a value between 0 and 15.</td>
32</tr>
33<tr>
34<td><em><strong><code>trackBitMask</code></strong></em></td>
35<td>This is the track bit mask. It designates which track to use.</td>
36</tr>
37<tr>
38<td><em><strong><code>depth</code></strong></em></td>
39<td>The modulation depth. Takes a value between 0 and 255.</td>
40</tr>
41</tbody>
42</table>
43</div>
44
45    </div>
46<div class="refsection" lang="ja"><a name="IDA5NWT"></a>
47      <h2>Return Values</h2>
48
49      <p>None.</p>
50    </div>
51<div class="refsection" lang="ja"><a name="IDAGOWT"></a>
52      <h2>Description</h2>
53      <p>
54Changes the modulation depth of the tracks of the sequence being played by the Player specified by <code>playerNo</code>.
55</p>
56      <p>
57The track bit mask, <em><strong><code>trackBitMask</code></strong></em>, designates which track to use. Each bit expresses a track in descending order track 0 as the lowest bit. Operations are performed only on tracks with active bits.
58</p>
59      <p>
60The default value for the modulation depth <code>depth</code> is 0. In other words, there is no modulation effect in the default setting. The larger the value, the  greater the effect. When the modulation type is the default type &quot;note  change,&quot; then a modulation depth value of 127 is exactly one half-note.
61</p>
62      <div class="note">
63<h3 class="title">Note</h3>
64<p>
65If a modulation depth value is already set inside the sequence data, the value set later is the one that is valid.
66</p>
67<p>
68This function is an ARM7 reserved function. After this function is called, its processing will occur only after the command is issued with the <tt class="function"><a href="SND_FlushCommand.html">SND_FlushCommand</a></tt> function.
69</p>
70<p>
71If program execution must be synchronized with process completion, first use the <tt class="function"><a href="SND_GetCurrentCommandTag.html">SND_GetCurrentCommandTag</a></tt> function to obtain the command tag immediately after calling this function. Then, after the command is issued, use the command tag and call either the <tt class="function"><a href="SND_IsFinishedCommandTag.html">SND_IsFinishedCommandTag</a></tt> or <tt class="function"><a href="SND_WaitForCommandProc.html">SND_WaitForCommandProc</a></tt> function to confirm that processing has finished or to wait for it to complete.
72</p>
73</div>
74    </div>
75<h2>See Also</h2>
76<p><code><a href="SND_FlushCommand.html">SND_FlushCommand</a>, <a href="SND_GetCurrentCommandTag.html">SND_GetCurrentCommandTag</a>, <a href="SND_IsFinishedCommandTag.html">SND_IsFinishedCommandTag</a>, <a href="SND_WaitForCommandProc.html">SND_WaitForCommandProc</a></code></p>
77<h2>Revision History</h2>
78<p>
792005/02/17 Added a note about ARM7 command processing. <br>2004/07/01 Initial version.
80</p>
81</div>
82<hr><p>CONFIDENTIAL</p></body>
83</html>
84