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    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50    <title>nw::snd::SoundSystem::SoundSystemParam</title>
51  </head>
52  <body>
53    <h1>nw::snd::SoundSystem::SoundSystemParam Structure</h1>
54    <div class="section">
55      <b>Header file: </b>nw/snd/snd_SoundSystem.h</div>
56    <h2>Syntax</h2>
57    <div class="section">
58      <pre class="definition">struct SoundSystemParam
59{
60   <span>s32</span> soundThreadPriority;
61   <span>s32</span> soundThreadCoreNo;
62   size_t soundThreadStackSize;
63   <span>s32</span> taskThreadPriority;
64   size_t taskThreadStackSize;
65   bool autoCreateSoundThread;
66   bool enableGetSoundThreadTick;
67};
68</pre>
69    </div>
70    <h2>Description</h2>
71    <div class="section">
72      <p>Structure used to initialize the sound system.</p><p>Setting soundThreadCoreNo to 1 allows sound threads to be processed in the system core (Core 1).</p></div>
73    <a name="constant" id="constant">
74      <h2>Member Constants</h2>
75      <div class="section">
76        <table class="members">
77          <tr>
78            <td width="100">
79              <span class="static_style" title="static">S</span>
80            </td>
81            <th>
82              <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_SOUND_THREAD_PRIORITY.html">DEFAULT_SOUND_THREAD_PRIORITY</a></span>
83            </th>
84            <td>The default priority for sound threads.</td>
85          </tr>
86          <tr>
87            <td width="100">
88              <span class="static_style" title="static">S</span>
89            </td>
90            <th>
91              <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_TASK_THREAD_PRIORITY.html">DEFAULT_TASK_THREAD_PRIORITY</a></span>
92            </th>
93            <td>The default priority for threads that load sound data.</td>
94          </tr>
95          <tr>
96            <td width="100">
97              <span class="static_style" title="static">S</span>
98            </td>
99            <th>
100              <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_SOUND_THREAD_STACK_SIZE.html">DEFAULT_SOUND_THREAD_STACK_SIZE</a></span>
101            </th>
102            <td>The default stack size for sound threads.</td>
103          </tr>
104          <tr>
105            <td width="100">
106              <span class="static_style" title="static">S</span>
107            </td>
108            <th>
109              <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_TASK_THREAD_STACK_SIZE.html">DEFAULT_TASK_THREAD_STACK_SIZE</a></span>
110            </th>
111            <td>The default stack size for threads that load sound data.</td>
112          </tr> </table>
113      </div>
114    </a> <a name="variable" id="variable">
115      <h2>Member Variables</h2>
116      <div class="section">
117        <table class="members">
118          <tr>
119            <td width="100"> </td>
120            <th>
121              <span class="argument">soundThreadPriority</span>
122            </th>
123            <td>Sound thread priority. The initial value is 4.</td>
124          </tr>
125          <tr>
126            <td width="100"> </td>
127            <th>
128              <span class="argument">soundThreadCoreNo</span>
129            </th>
130            <td>The sound thread core number. The initial value is 0.</td>
131          </tr>
132          <tr>
133            <td width="100"> </td>
134            <th>
135              <span class="argument">soundThreadStackSize</span>
136            </th>
137            <td>Size of the sound thread stack. Specify a value that is a multiple of 8. The default value is 16KB.</td>
138          </tr>
139          <tr>
140            <td width="100"> </td>
141            <th>
142              <span class="argument">taskThreadPriority</span>
143            </th>
144            <td>Sound data load thread priority. The initial value is 3.</td>
145          </tr>
146          <tr>
147            <td width="100"> </td>
148            <th>
149              <span class="argument">taskThreadStackSize</span>
150            </th>
151            <td>Stack size for threads that load sound data. Specify a value that is a multiple of 8. The default value is 16KB.</td>
152          </tr>
153          <tr>
154            <td width="100"> </td>
155            <th>
156              <span class="argument">autoCreateSoundThread</span>
157            </th>
158            <td>Flag indicating whether a sound thread is created automatically by <a href="../../../../nw/snd/SoundSystem/Initialize.html">Initialize</a>. The initial value is <CODE>true</CODE>. If false, soundThreadStackSize and soundThreadPriorityare ignored.</td>
159          </tr>
160          <tr>
161            <td width="100"> </td>
162            <th>
163              <span class="argument">enableGetSoundThreadTick</span>
164            </th>
165            <td>Flag indicating whether to measure the sound thread processing load. The initial value is <CODE>true</CODE>. If false, <a href="../../../../nw/snd/SoundSystem/GetSoundThreadTickCount.html">GetSoundThreadTickCount</a> does not function normally.</td>
166          </tr> </table>
167      </div>
168    </a> <a name="function" id="function">
169      <h2>Member Functions</h2>
170      <div class="section">
171        <table class="members">
172          <tr>
173            <td width="100">  </td>
174            <th>
175              <a href="../../../../nw/snd/SoundSystem/SoundSystemParam/SoundSystemParam.html">SoundSystemParam</a>
176            </th>
177            <td>Constructor.</td>
178          </tr> </table>
179      </div>
180    </a>
181    <h2>See Also</h2>
182    <div class="section">
183      <p class="reference"><a href="../../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a> Class<br /> </p>
184    </div>
185    <h2>Revision History</h2>
186    <div class="section">
187      <dl class="history">
188        <dt>2010/09/24</dt>
189        <dd>Added the members soundThreadCoreNo and enableGetSoundThreadTick<br />
190        </dd>
191        <dt>2010/01/29</dt>
192        <dd>Changed the types of member variables (from u32 to size_t) and names (from romThread*** to taskThread***).
193        </dd>
194        <dt>2010/01/15</dt>
195        <dd>Initial version.<br />
196        </dd>
197      </dl>
198    </div>
199  <hr><p>CONFIDENTIAL</p></body>
200</html>