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>CreateRenderTarget</title>
8  </head>
9  <body>
10    <h1>nn::gd::CTR::OutputStage::CreateRenderTarget Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> CreateRenderTarget(
15     const Texture2DResource * texture2DResource,
16     const <a href="../../../../nn/gd/CTR/RenderTargetDescription/Overview.html">RenderTargetDescription</a> * desc,
17     RenderTarget ** renderTarget
18);
19</pre>
20    </div>
21    <h2>Arguments</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>in</td>
33          <th>texture2DResource</th>
34          <td>Specifies a pointer to an already created <SPAN class="Argument">Texture2DResource</SPAN> object.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>desc</th>
39          <td>Sets parameters for creating a render target.</td>
40        </tr>
41        <tr>
42          <td>out</td>
43          <th>renderTarget</th>
44          <td>Specifies the address storing a pointer to the created render target object.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">Returns the result of the operation. <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52            <th>Value</th>
53            <td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57          <th><CODE>ResultSuccess</CODE></th>
58          <td>Process was successful.</td>
59        </tr>
60        <tr>
61          <th>ResultNullParameter</th>
62          <td><CODE>NULL</CODE> was specified in an argument.</td>
63        </tr>
64        <tr>
65          <th>ResultInvalidTextureMipLevelIndex</th>
66          <td>m_mipLevelIndex in <a href="../../../../nn/gd/CTR/RenderTargetDescription/Overview.html">RenderTargetDescription</a> is larger than the mipmap level of the specified resource. </td>
67        </tr>
68        <tr>
69          <th>ResultInvalidTextureResolution</th>
70          <td>The height or width of <SPAN class="Argument">Texture2DResource</SPAN> is 0 or greater than 1024, or the size is not a multiple of eight.  Or, the memory layout of the <SPAN class="Argument">Texture2DResource</SPAN> resource is <CODE>LAYOUT_BLOCK_32</CODE>, but the height and width of the <SPAN class="Argument">Texture2DResource</SPAN> resource is not a multiple of 32. </td>
71        </tr>
72        <tr>
73          <th>ResultInvalidTextureFormatForCreatingRenderTarget</th>
74          <td>The pixel format of <SPAN class="Argument">Texture2DResource</SPAN> is invalid. </td>
75        </tr>
76        <tr>
77          <th>ResultInvalidMemoryLocation</th>
78          <td>The memory type of <SPAN class="Argument">Texture2DResource</SPAN> is invalid. Specify VRAM memory type.</td>
79        </tr>
80        <tr>
81          <th>ResultOutOfMemory</th>
82          <td>Cannot allocate memory.</td>
83        </tr>
84      </table> </div>
85    <h2>Description</h2>
86    <div class="section">
87      <p>Creates a render target from a <CODE>Texture2DResource</CODE>.</p><p>Pixel formats that can be specified for the <CODE>Texture2DResource</CODE>:  <br /><itemizedlist><listitem><para>NATIVE_FORMAT_RGBA_8888 <br /></para></listitem><listitem><para>NATIVE_FORMAT_GAS <br /></para></listitem><listitem><para>NATIVE_FORMAT_SHADOW <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGBA_5551 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGB_565 <br /></para></listitem><listitem><para>NATIVE_FORMAT_RGBA_4444 <br /></para></listitem></itemizedlist></p><!-- write here --></div>
88    <h2>See Also</h2>
89    <div class="section">
90      <p class="reference">The <a href="../../../../nn/gd/CTR/Resource/CreateTexture2DResource.html"><CODE>Resource::CreateTexture2DResource</CODE></a> function creates a <SPAN class="Argument">Texture2DResource</SPAN> object.<br /> </p>
91    </div>
92    <h2>Revision History</h2>
93    <div class="section">
94      <dl class="history">
95        <dt>2011/02/17</dt>
96        <dd>Initial version.<br />
97        </dd>
98      </dl>
99    </div>
100  <hr><p>CONFIDENTIAL</p></body>
101</html>
102