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 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::snd::SoundHeap</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::SoundHeap</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_SoundHeap.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class SoundHeap : public <a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">nw::snd::SoundMemoryAllocatable</a></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A heap class used for sound data.</p><p>In sound heaps, you can set a callback function to be called when a memory block is freed by the sound heap. This feature is used in the Sound library to perform processing to safely free the data when a memory block that contains sound data has been released.</p></div> 61 <a name="typedef" id="typedef"> 62 <h2><CODE>typedef</CODE> Definitions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100" /> 67 <th> 68 <a href="../../../nw/snd/SoundHeap/DisposeCallback.html">DisposeCallback</a> 69 </th> 70 <td>Called when a memory block has been destroyed.</td> 71 </tr> </table> 72 </div> 73 </a> <a name="function" id="function"> 74 <h2>Member Functions</h2> 75 <div class="section"> 76 <table class="members"> 77 <tr> 78 <th class="category" colspan="3">Constructors/Destructors</th> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83 <a href="../../../nw/snd/SoundHeap/SoundHeap.html">SoundHeap</a> 84 </th> 85 <td>Constructor.</td> 86 </tr> 87 <tr> 88 <td width="100"> <span class="virtual_style" title="virtual">V</span> 89 </td> 90 <th> 91 <a href="../../../nw/snd/SoundHeap/~SoundHeap.html">~SoundHeap</a> 92 </th> 93 <td>Destructor.</td> 94 </tr> 95 <tr> 96 <th class="category" colspan="3">Heap Operations</th> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101 <a href="../../../nw/snd/SoundHeap/Create.html"><CODE>Create</CODE></a> 102 </th> 103 <td>Creates the sound heap.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108 <a href="../../../nw/snd/SoundHeap/Destroy.html"><CODE>Destroy</CODE></a> 109 </th> 110 <td>Destroys the sound heap.</td> 111 </tr> 112 <tr> 113 <td width="100"> <span class="virtual_style" title="virtual">V</span> 114 </td> 115 <th> 116 <a href="../../../nw/snd/SoundHeap/Alloc.html"><CODE>Alloc</CODE></a> 117 </th> 118 <td>Allocates memory from the sound heap.</td> 119 </tr> 120 <tr> 121 <td width="100"> </td> 122 <th> 123 <a href="../../../nw/snd/SoundHeap/Clear.html"><CODE>Clear</CODE></a> 124 </th> 125 <td>Frees all allocated memory blocks.</td> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130 <a href="../../../nw/snd/SoundHeap/IsValid.html"><CODE>IsValid</CODE></a> 131 </th> 132 <td>Checks whether the sound heap is enabled.</td> 133 </tr> 134 <tr> 135 <th class="category" colspan="3">Hierarchy Control</th> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140 <a href="../../../nw/snd/SoundHeap/SaveState.html">SaveState</a> 141 </th> 142 <td>Saves the current state of the sound heap.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147 <a href="../../../nw/snd/SoundHeap/LoadState.html">LoadState</a> 148 </th> 149 <td>Restores the state of the saved sound heap.</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154 <a href="../../../nw/snd/SoundHeap/GetCurrentLevel.html">GetCurrentLevel</a> 155 </th> 156 <td>Obtains the current hierarchical level of the sound heap.</td> 157 </tr> 158 <tr> 159 <th class="category" colspan="3">Getting Information</th> 160 </tr> 161 <tr> 162 <td width="100"> </td> 163 <th> 164 <a href="../../../nw/snd/SoundHeap/GetSize.html">GetSize</a> 165 </th> 166 <td>Gets the size of the heap in memory.</td> 167 </tr> 168 <tr> 169 <td width="100"> </td> 170 <th> 171 <a href="../../../nw/snd/SoundHeap/GetFreeSize.html">GetFreeSize</a> 172 </th> 173 <td>Gets the amount of free heap space in memory.</td> 174 </tr> 175 <tr> 176 <td width="100"> </td> 177 <th> 178 <a href="../../../nw/snd/SoundHeap/Dump.html">Dump</a> 179 </th> 180 <td>Dumps the contents of the heap.</td> 181 </tr> </table> 182 </div> 183 </a> 184 <h2>Class Hierarchy</h2> 185 <div class="section"> 186 <p class="hierarchy"><a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">nw::snd::SoundMemoryAllocatable</a><br /> <b>nw::snd::SoundHeap</b> 187 </p> 188 </div> 189 <h2>Revision History</h2> 190 <div class="section"> 191 <dl class="history"> 192 <dt>2009/12/28</dt> 193 <dd>Initial version.<br /> 194 </dd> 195 </dl> 196 </div> 197 <hr><p>CONFIDENTIAL</p></body> 198</html> 199