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    <title>Create</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundHeap/Overview.html">SoundHeap</a>::Create</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHeap.h&gt;
14bool Create(
15     void* startAddress,
16     size_t size
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>startAddress</th>
33          <td>Starting address of the memory to use as the heap.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th><CODE>size</CODE></th>
38          <td>Size of the memory to use as the heap.</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">Returns <span>true</span> if the heap is created successfully and <span>false</span> otherwise. </div>
43    <h2>Description</h2>
44    <div class="section">
45      <p>Creates the sound heap.</p><p>The function fails if the size of the memory region (<span>size</span>) is insufficient. Also, because a heap management region is necessary, the size of the heap in memory is smaller than <span>size</span>.</p><p>To reuse the memory area passed to this function, use the <a href="../../../nw/snd/SoundHeap/Destroy.html">nw::snd::SoundHeap::Destroy</code> function to destroy the heap.</p><p>When loading wave data, you must set <span>startAddress</span> to an address in device memory.</p></div>
46    <h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2009/12/28</dt>
50        <dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>
56