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>ClearTargets</title>
8  </head>
9  <body>
10    <h1>nn::gd::CTR::Memory::ClearTargets Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nnResult/Overview.html">nnResult</a> ClearTargets(
15     const RenderTarget * renderTarget,
16     const DepthStencilTarget * depthStencilTarget,
17     const u8 ColorRGBA[4],
18     float depth,
19     u8 stencil
20);
21</pre>
22    </div>
23    <h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29            <th>Name</th>
30            <td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34          <td>in</td>
35          <th>renderTarget</th>
36          <td>Specifies a pointer to the render target to be cleared.</td>
37        </tr>
38        <tr>
39          <td>in</td>
40          <th>depthStencilTarget</th>
41          <td>Specifies a pointer to the depth stencil target to be cleared.</td>
42        </tr>
43        <tr>
44          <td>in</td>
45          <th>ColorRGBA[4]</th>
46          <td>Specifies a color value for the RGB format used by the render target to be cleared.</td>
47        </tr>
48        <tr>
49          <td>in</td>
50          <th>depth</th>
51          <td>Specifies a depth value for the depth stencil target to be cleared.</td>
52        </tr>
53        <tr>
54          <td>in</td>
55          <th>stencil</th>
56          <td>Specifies a stencil value for the depth stencil target to be cleared.</td>
57        </tr> </table>
58    </div>
59    <h2>Return Values</h2>
60    <div class="section">Returns the result of the operation. <br />
61      <table class="arguments">
62        <thead>
63          <tr>
64            <th>Value</th>
65            <td>Description</td>
66          </tr>
67        </thead>
68        <tr>
69          <th>ResultSuccess</th>
70          <td>Process was successful.</td>
71        </tr>
72        <tr>
73          <th>ResultInvalidTextureFormat</th>
74          <td>Indicates that the pixel format of the specified render target or depth stencil target is invalid.</td>
75        </tr>
76      </table> </div>
77    <h2>Description</h2>
78    <div class="section">
79      <p>Adds a command for clearing the specified target memory. </p><p>Pixel formats that can be specified for the render target:  <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 /> . <br /></para></listitem></itemizedlist></p><p>Pixel formats that can be specified for the depth stencil target:  <br /><itemizedlist><listitem><para>NATIVE_FORMAT_DEPTH_24_STENCIL_8 <br /></para></listitem><listitem><para>NATIVE_FORMAT_DEPTH_24 <br /></para></listitem><listitem><para>NATIVE_FORMAT_DEPTH_16 <br /> . <br /></para></listitem></itemizedlist></p><!-- write here --></div>
80    <h2>Revision History</h2>
81    <div class="section">
82      <dl class="history">
83        <dt>2011/02/17</dt>
84        <dd>Initial version.<br />
85        </dd>
86      </dl>
87    </div>
88  <hr><p>CONFIDENTIAL</p></body>
89</html>
90