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><a href="../../../../nw/Overview.html">nw</a>::<a href="../../../../nw/snd/Overview.html">snd</a>::<a href="../../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a>::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><p>If autoCreateSoundThread is set to false, the user must create threads used by sound thread on his or her own. Because the user is not permitted to create threads that run in the system core, the sound thread must be run in the application core (core 0) in such cases. </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 width="100">const <span>s32</span></td> 85 <td>The default priority for sound threads.</td> 86 </tr> 87 <tr> 88 <td width="100"> 89 <span class="static_style" title="static">S</span> 90 </td> 91 <th> 92 <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_TASK_THREAD_PRIORITY.html">DEFAULT_TASK_THREAD_PRIORITY</a></span> 93 </th> 94 <td width="100">const <span>s32</span></td> 95 <td>The default priority for threads that load sound data.</td> 96 </tr> 97 <tr> 98 <td width="100"> 99 <span class="static_style" title="static">S</span> 100 </td> 101 <th> 102 <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_SOUND_THREAD_STACK_SIZE.html">DEFAULT_SOUND_THREAD_STACK_SIZE</a></span> 103 </th> 104 <td width="100">const <span>u32</span></td> 105 <td>The default stack size for sound threads.</td> 106 </tr> 107 <tr> 108 <td width="100"> 109 <span class="static_style" title="static">S</span> 110 </td> 111 <th> 112 <span class="argument"><a href="../../../../nw/snd/SoundSystem/SoundSystemParam/DEFAULT_TASK_THREAD_STACK_SIZE.html">DEFAULT_TASK_THREAD_STACK_SIZE</a></span> 113 </th> 114 <td width="100">const <span>u32</span></td> 115 <td>The default stack size for threads that load sound data.</td> 116 </tr> </table> 117 </div> 118 </a> <a name="variable" id="variable"> 119 <h2>Member Variables</h2> 120 <div class="section"> 121 <table class="members"> 122 <tr> 123 <td width="100"> </td> 124 <th> 125 <span class="argument">soundThreadPriority</span> 126 </th> 127 <td width="100"><span>s32</span></td> 128 <td>Sound thread priority. The initial value is 4.</td> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133 <span class="argument">soundThreadCoreNo</span> 134 </th> 135 <td width="100"><span>s32</span></td> 136 <td>The sound thread core number. The initial value is 0.</td> 137 </tr> 138 <tr> 139 <td width="100"> </td> 140 <th> 141 <span class="argument">soundThreadStackSize</span> 142 </th> 143 <td width="100">size_t</td> 144 <td>Size of the sound thread stack. Specify a value that is a multiple of 8. The default value is 16KB.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <span class="argument">taskThreadPriority</span> 150 </th> 151 <td width="100"><span>s32</span></td> 152 <td>Sound data load thread priority. The initial value is 3.</td> 153 </tr> 154 <tr> 155 <td width="100"> </td> 156 <th> 157 <span class="argument">taskThreadStackSize</span> 158 </th> 159 <td width="100">size_t</td> 160 <td>Stack size for threads that load sound data. Specify a value that is a multiple of 8. The default value is 16KB.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <span class="argument">autoCreateSoundThread</span> 166 </th> 167 <td width="100">bool</td> 168 <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, soundThreadPriority, and soundThreadCoreNo are ignored.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <span class="argument">enableGetSoundThreadTick</span> 174 </th> 175 <td width="100">bool</td> 176 <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> 177 </tr> </table> 178 </div> 179 </a> <a name="function" id="function"> 180 <h2>Member Functions</h2> 181 <div class="section"> 182 <table class="members"> 183 <tr> 184 <td width="100"> </td> 185 <th> 186 <a href="../../../../nw/snd/SoundSystem/SoundSystemParam/SoundSystemParam.html">SoundSystemParam</a> 187 </th> 188 <td>Constructor.</td> 189 </tr> </table> 190 </div> 191 </a> 192 <h2>See Also</h2> 193 <div class="section"> 194 <p class="reference"><a href="../../../../nw/snd/SoundSystem/Overview.html">SoundSystem</a> Class<br /> </p> 195 </div> 196 <h2>Revision History</h2> 197 <div class="section"> 198 <dl class="history"> 199 <dt>2010/12/02</dt> 200 <dd>Added mention of the fact that soundThreadCoreNo is ignored to the description of autoCreateSoundThread.<BR> 201 </dd> 202 <dt>2010/09/24</dt> 203 <dd>Added the members soundThreadCoreNo and enableGetSoundThreadTick<br /> 204 </dd> 205 <dt>2010/01/29</dt> 206 <dd>Changed the types of member variables (from u32 to size_t) and names (from romThread*** to taskThread***). 207 </dd> 208 <dt>2010/01/15</dt> 209 <dd>Initial version.<br /> 210 </dd> 211 </dl> 212 </div> 213 <hr><p>CONFIDENTIAL</p></body> 214</html>