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>ClearTexture2DResource</title>
8  </head>
9  <body>
10    <h1>nn::gd::CTR::Memory::ClearTexture2DResource Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> ClearTexture2DResource(
15     const Texture2DResource * tex2DResource,
16     s32 mipLevelIndexStart,
17     s32 mipLevelIndexEnd,
18     u32 value
19);
20</pre>
21    </div>
22    <h2>Arguments</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>tex2DResource</th>
35          <td>Specifies a pointer to the <SPAN class="Argument">Texture2DResource</SPAN> to be cleared. Only a <CODE>VRAM</CODE> resource can be specified. </td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>mipLevelIndexStart</th>
40          <td>Specifies the index of the first mipmap level to be cleared. (If -1 is specified, the last mipmap level index is used.)</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>mipLevelIndexEnd</th>
45          <td>Specifies the index of the last mipmap level to be cleared. (If -1 is specified, the last mipmap level index is used.)</td>
46        </tr>
47        <tr>
48          <td>in</td>
49          <th>value</th>
50          <td>Specifies the color value to be cleared.</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>ResultSuccess</CODE></th>
64          <td>Process was successful.</td>
65        </tr>
66        <tr>
67          <th>ResultNullParameter</th>
68          <td><CODE>NULL</CODE> was specified for the specified resource. </td>
69        </tr>
70        <tr>
71          <th>ResultInvalidTextureMipLevelIndex</th>
72          <td>A value larger than <SPAN class="Argument">mipLevelIndexEnd</SPAN> has been specified for <SPAN class="Argument">mipLevelIndexStart</SPAN>. Or, a value larger than the mipmap level of the specified <SPAN class="Argument">tex2DResource</SPAN> has been specified for <SPAN class="Argument">mipLevelIndexEnd</SPAN>. </td>
73        </tr>
74        <tr>
75          <th>ResultInvalidMemoryRegion</th>
76          <td>The resource memory type is invalid. The specified resource is in FCRAM region memory. </td>
77        </tr>
78      </table> </div>
79    <h2>Description</h2>
80    <div class="section">
81      <p>Adds a command for clearing <SPAN class="Argument">Texture2DResource</SPAN> using the specified value to the current command list.</p><!-- write here --></div>
82    <h2>Revision History</h2>
83    <div class="section">
84      <dl class="history">
85        <dt>2011/02/21</dt>
86        <dd>Initial version.<br />
87        </dd>
88      </dl>
89    </div>
90  <hr><p>CONFIDENTIAL</p></body>
91</html>
92