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::SoundHeap</title> 51 </head> 52 <body> 53 <h1>nw::snd::SoundHeap Class</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_SoundHeap.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">class SoundHeap : public <a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">nw::snd::SoundMemoryAllocatable</a></pre> 59 </div> 60 <h2>Description</h2> 61 <div class="section"> 62 <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> 63 <a name="typedef" id="typedef"> 64 <h2><CODE>typedef</CODE> Definitions</h2> 65 <div class="section"> 66 <table class="members"> 67 <tr> 68 <td width="100" /> 69 <th> 70 <a href="../../../nw/snd/SoundHeap/DisposeCallback.html">DisposeCallback</a> 71 </th> 72 <td>Called when a memory block has been destroyed.</td> 73 </tr> </table> 74 </div> 75 </a> <a name="function" id="function"> 76 <h2>Member Functions</h2> 77 <div class="section"> 78 <table class="members"> 79 <tr> 80 <th class="category" colspan="3">Constructors/Destructors</th> 81 </tr> 82 <tr> 83 <td width="100"> </td> 84 <th> 85 <a href="../../../nw/snd/SoundHeap/SoundHeap.html">SoundHeap</a> 86 </th> 87 <td>Constructor.</td> 88 </tr> 89 <tr> 90 <td width="100"> <span class="virtual_style" title="virtual">V</span> 91 </td> 92 <th> 93 <a href="../../../nw/snd/SoundHeap/~SoundHeap.html">~SoundHeap</a> 94 </th> 95 <td>Destructor.</td> 96 </tr> 97 <tr> 98 <th class="category" colspan="3">Heap Operations</th> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <a href="../../../nw/snd/SoundHeap/Create.html">Create</a> 104 </th> 105 <td>Creates the sound heap.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <a href="../../../nw/snd/SoundHeap/Destroy.html"><CODE>Destroy</CODE></a> 111 </th> 112 <td>Destroys the sound heap.</td> 113 </tr> 114 <tr> 115 <td width="100"> <span class="virtual_style" title="virtual">V</span> 116 </td> 117 <th> 118 <a href="../../../nw/snd/SoundHeap/Alloc.html">Alloc</a> 119 </th> 120 <td>Allocates memory from the sound heap.</td> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125 <a href="../../../nw/snd/SoundHeap/Clear.html"><CODE>Clear</CODE></a> 126 </th> 127 <td>Frees all allocated memory blocks.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132 <a href="../../../nw/snd/SoundHeap/IsValid.html"><CODE>IsValid</CODE></a> 133 </th> 134 <td>Checks whether the sound heap is enabled.</td> 135 </tr> 136 <tr> 137 <th class="category" colspan="3">Hierarchy Control</th> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../../nw/snd/SoundHeap/SaveState.html">SaveState</a> 143 </th> 144 <td>Saves the current state of the sound heap.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <a href="../../../nw/snd/SoundHeap/LoadState.html">LoadState</a> 150 </th> 151 <td>Restores the state of the saved sound heap.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156 <a href="../../../nw/snd/SoundHeap/GetCurrentLevel.html">GetCurrentLevel</a> 157 </th> 158 <td>Obtains the current hierarchical level of the sound heap.</td> 159 </tr> 160 <tr> 161 <th class="category" colspan="3">Getting Information</th> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166 <a href="../../../nw/snd/SoundHeap/GetSize.html"><CODE>GetSize</CODE></a> 167 </th> 168 <td>Gets the size of the heap in memory.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../nw/snd/SoundHeap/GetFreeSize.html">GetFreeSize</a> 174 </th> 175 <td>Gets the amount of free heap space in memory.</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <a href="../../../nw/snd/SoundHeap/Dump.html"><CODE>Dump</CODE></a> 181 </th> 182 <td>Dumps the contents of the heap.</td> 183 </tr> </table> 184 </div> 185 </a> 186 <h2>Class Hierarchy</h2> 187 <div class="section"> 188 <p class="hierarchy"><a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">nw::snd::SoundMemoryAllocatable</a><br /> <b>nw::snd::SoundHeap</b> 189 </p> 190 </div> 191 <h2>Revision History</h2> 192 <div class="section"> 193 <dl class="history"> 194 <dt>2009/12/28</dt> 195 <dd>Initial version.<br /> 196 </dd> 197 </dl> 198 </div> 199 <hr><p>CONFIDENTIAL</p></body> 200</html>