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>CreateTextureCube</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/TextureStage/Overview.html">TextureStage</a>::CreateTextureCube</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> CreateTextureCube(
15     Texture2DResource ** tex2DResources,
16     <a href="../../../../nn/gd/CTR/TextureCubeDescription/Overview.html">TextureCubeDescription</a> * desc,
17     TextureCube ** textureCube
18);
19</pre>
20    </div>
21<h2>Parameters</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td />
33<th>tex2DResources</th>
34          <td>
35            </td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>desc</th>
40<td>Specifies a parameter used to create a texture cube.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>textureCube</th>
45<td>Specifies the address storing a pointer to the created texture cube object.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>tex2DResource</th>
50<td>Specifies a pointer array to an already created six-sided <CODE>Texture2DResource</CODE> object. The array must specify elements in the following order. (<CODE>X_POS</CODE>, <CODE>X_NEG</CODE>, <CODE>Y_POS</CODE>, <CODE>Y_NEG</CODE>, <CODE>Z_POS</CODE>, <CODE>Z_NEG</CODE>)</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><CODE>Result::IsSuccess</CODE></th>
64<td>Process was successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNullParameter</CODE></th>
68<td><CODE>NULL</CODE> was specified in an argument.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidTextureFormat</CODE></th>
72<td>A gas texture format was specified or the pixel format is incorrect.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultInvalidMemoryLayout</CODE></th>
76<td>The memory layout was not <span>Memory::LAYOUT_BLOCK_8</span>.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultInvalidMemoryLocation</CODE></th>
80<td>Resources were not all in the same memory region (FCRAM or VRAM).</td>
81        </tr>
82        <tr>
83<th><CODE>ResultInvalidTextureMipLevelIndex</CODE></th>
84<td>The mipmap level is incorrect. Or, mipmap levels cannot be used in the case of a shadow texture. Always specify 1.</td>
85        </tr>
86        <tr>
87<th><CODE>ResultInvalidTextureResolution</CODE></th>
88<td>The resolution width or height is incorrect. Must be specified as a power of two. The maximum size is 1024 x 1024. Or, the resource had a different resolution.</td>
89        </tr>
90        <tr>
91<th><CODE>ResultInvalidMemoryLocation</CODE></th>
92<td>The upper 7 bits of the addresses for the resource's six sides do not share the same values. The address for each of the six sides must have the same 7 upper bits.</td>
93        </tr>
94        <tr>
95<th><CODE>ResultOutOfMemory</CODE></th>
96<td>Could not allocate memory.</td>
97        </tr>
98      </table> </div>
99<h2>Description</h2>
100    <div class="section">
101<p>Creates a texture cube object from a <CODE>Texture2DResource</CODE>.</p><p>You must set the same resolution, pixel format, and mipmap level <CODE>Texture2DResource</CODE> for the six sides of the texture cube. Furthermore, all six faces must fit inside a 32 MB boundary. The memory layout must be set to <span>Memory::LAYOUT_BLOCK_8</span>, and the <CODE>Texture2DResource</CODE> resolution must be set to square. </p><!-- write here --></div>
102<h2>See Also</h2>
103    <div class="section">
104<p class="reference">The <a href="../../../../nn/gd/CTR/Resource/CreateTexture2DResource.html"><CODE>Resource::CreateTexture2DResource</CODE></a> function creates a <CODE>Texture2DResource</CODE> resource object.<br /><a href="../../../../nn/gd/CTR/Resource/CreateTexture2DResource.html">The <a href="../../../../nn/gd/CTR/Resource/CreateTexture2DResource.html"><CODE>Resource::CreateTexture2DResource</CODE></a> function creates a <CODE>Texture2DResource</CODE> object.<br /> </p>
105    </div>
106<h2>Revision History</h2>
107    <div class="section">
108      <dl class="history">
109        <dt>2011/02/17</dt>
110<dd>Initial version.<br />
111        </dd>
112      </dl>
113    </div>
114  <hr><p>CONFIDENTIAL</p></body>
115</html>