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>ColorizeMipmaps</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/System/Overview.html">System</a>::<a href="../../../../../nn/gd/CTR/System/Debug/Overview.html">Debug</a>::ColorizeMipmaps</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../../nnResult/Overview.html">nnResult</a> ColorizeMipmaps(
15     Texture2DResource * texture2DResource,
16     <a href="../../../../../nn_types/s32.html">s32</a> minMipLevelIndex,
17     <a href="../../../../../nn_types/s32.html">s32</a> maxMipLevelIndex,
18     <a href="../../../../../nn_types/u8.html">u8</a> colors[][4]
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><CODE>texture2DResource</CODE></th>
35<td>Specifies a pointer to the target <CODE>Texture2DResource</CODE> resource.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th><CODE>minMipLevelIndex</CODE></th>
40<td>Specifies the lowest mipmap level index to be colored. [0, texture2DResource-&gt;mipLevels] Specifying <CODE>-1</CODE> uses the last mipmap level.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th><CODE>maxMipLevelIndex</CODE></th>
45<td>Specifies the highest mipmap level index to be colored. [0, texture2DResource-&gt;mipLevels] Specifying <CODE>-1</CODE> uses the last mipmap level.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>colors[][4]</th>
50<td>Specifies an array of colors used to color in mipmap levels. The array specifies the color values used to color each mipmap level. (Specify <CODE>minMipLevelIndex</CODE> and <CODE>maxMipLevelIndex</CODE>.) If <CODE>NULL</CODE> is given for a color value, the initial array for color values is used.</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 for the specified resource. </td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidTextureFormat</CODE></th>
72<td>A format other than ETC and depth formats included in <a href="../../../../../nn/gd/CTR/Resource/NativeFormat.html"><CODE>Resource::NativeFormat</CODE></a>, has been specified for the format of the resource.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultInvalidTextureMipLevelIndex</CODE></th>
76<td>A value larger than <CODE>mipLevelIndexEnd</CODE> has been specified for <CODE>mipLevelIndexStart</CODE>. Or, a value larger than the mipmap level of the specified <CODE>tex2DResource</CODE> has been specified for <CODE>mipLevelIndexEnd</CODE>. </td>
77        </tr>
78        <tr>
79<th><CODE>ResultInvalidMemoryRegion</CODE></th>
80<td>The resource memory type is invalid. The specified resource is in <CODE>FCRAM</CODE> region memory.</td>
81        </tr>
82      </table> </div>
83<h2>Description</h2>
84    <div class="section">
85<p>Colors the several mipmap levels of a resource with a single color.</p><p>The following color values are used when NULL is specified for colors[][4].</p><table><thead><tr><td width="30"><CODE>index</CODE></td><td width="30">R</td><td width="30">G</td><td width="30">B</td><td width="30">A</td><td /></tr></thead><tr><td>0</td><td>0</td><td>0</td><td>255</td><td>255</td><td /></tr><tr><td>1</td><td>255</td><td>0</td><td>0</td><td>255</td><td /></tr><tr><td>2</td><td>0</td><td>255</td><td>0</td><td>255</td><td /></tr><tr><td>3</td><td>255</td><td>0</td><td>255</td><td>255</td><td /></tr><tr><td>4</td><td>128</td><td>220</td><td>50</td><td>255</td><td /></tr><tr><td>5</td><td>100</td><td>50</td><td>120</td><td>255</td><td /></tr><tr><td>6</td><td>25</td><td>240</td><td>240</td><td>255</td><td /></tr><tr><td>7</td><td>220</td><td>20</td><td>150</td><td>255</td><td /></tr><tr><td>8</td><td>180</td><td>160</td><td>20</td><td>255</td><td /></tr></table></div>
86<h2>See Also</h2>
87    <div class="section">
88<p class="reference">Calls the <a href="../../../../../nn/gd/CTR/Memory/ClearTexture2DResource.html"><CODE>Memory::ClearTexture2DResource</CODE></a> function.<br /> </p>
89    </div>
90<h2>Revision History</h2>
91    <div class="section">
92      <dl class="history">
93        <dt>2011/12/27</dt>
94<dd>Initial version.<br />
95        </dd>
96      </dl>
97    </div>
98  <hr><p>CONFIDENTIAL</p></body>
99</html>