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>CreateVertexBufferResource</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/gd/Overview.html">gd</a>::<a href="../../../../nn/gd/CTR/Overview.html">CTR</a>::<a href="../../../../nn/gd/CTR/Resource/Overview.html">Resource</a>::CreateVertexBufferResource</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> CreateVertexBufferResource(
15     const <a href="../../../../nn/gd/CTR/VertexBufferResourceDescription/Overview.html">VertexBufferResourceDescription</a> * description,
16     const void * initialData,
17     VertexBufferResource ** buffer,
18     <span>gdBool</span> copyInitialData = GD_TRUE
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>description</th>
35<td>Specifies the descriptor for creating a resource buffer.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>initialData</th>
40<td>Specifies the initialization data.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>buffer</th>
45<td>Specifies the address for storing the pointer to the created vertex buffer resource.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>copyInitialData</th>
50<td>This parameter is used when initialization data is specified. The default is <CODE>true</CODE>. When this parameter is <CODE>true</CODE>, a memory area is allocated in the function (either FCRAM or VRAM specified by the descriptor), and then the initialization data is copied to the allocated memory. When this parameter is <CODE>false</CODE>, the <CODE>vertexBufferResource</CODE> memory address becomes the one allocated by the user (the address of <SPAN class="argument">initialData</SPAN>). In this case, the user must allocate a sufficient memory area with the correct memory alignment. If resources use some mipmaps, sufficient memory area must be allocated to all the mipmaps. Also, the user is responsible for releasing the data memory area after releasing the resource.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th>Result::IsSuccess</th>
64<td>The process was successful.</td>
65        </tr>
66        <tr>
67<th>ResultNullParameter</th>
68<td><CODE>NULL</CODE> was specified for <SPAN class="argument">description</SPAN> or <SPAN class="argument">buffer</SPAN>.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidParameter</CODE></th>
72<td><CODE>0</CODE> was specified for the vertex size.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultInvalidMemoryLocation</CODE></th>
76<td>The memory type is not valid.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultOutOfMemory</CODE></th>
80<td>Memory cannot be allocated for the resource object.</td>
81        </tr>
82        <tr>
83<th><CODE>ResultOutOfMemoryExt</CODE></th>
84<td>Memory cannot be allocated for the vertex buffer.</td>
85        </tr>
86      </table> </div>
87<h2>Description</h2>
88    <div class="section">
89<p>Creates a vertex buffer resource.</p><p>This function is used to create both vertex buffers and index buffers. <br /> This function adds commands to the command list. For more information, see the programming manual.</p><!-- write here --></div>
90<h2>See Also</h2>
91    <div class="section">
92<p class="reference"><a href="../../../../nn/gd/CTR/VertexBufferResourceDescription/Overview.html">VertexBufferResourceDescription</a><br /> </p>
93    </div>
94<h2>Revision History</h2>
95    <div class="section">
96      <dl class="history">
97        <dt>2011/02/17</dt>
98<dd>Initial version.<br />
99        </dd>
100      </dl>
101    </div>
102  <hr><p>CONFIDENTIAL</p></body>
103</html>
104