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    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::gr::CTR::FrameBuffer</title>
49  </head>
50  <body>
51<h1><CODE>nn::gr::CTR::FrameBuffer</CODE> Class</h1>
52<h2>Syntax</h2>
53    <div class="section">
54      <pre class="definition">class FrameBuffer</pre>
55    </div>
56<h2>Description</h2>
57    <div class="section">
58<p>Class for configuring framebuffer settings.</p><!-- write here --></div>
59    <a name="class" id="class">
60<h2>Classes</h2>
61      <div class="section">
62        <table class="members">
63          <tr>
64            <th>
65<a href="../../../../nn/gr/CTR/FrameBuffer/ColorBuffer/Overview.html"><CODE>nn::gr::CTR::FrameBuffer::ColorBuffer</CODE></a>
66            </th>
67<td>Class for configuring color buffer settings.</td>
68          </tr>
69          <tr>
70            <th>
71<a href="../../../../nn/gr/CTR/FrameBuffer/DepthStencilBuffer/Overview.html"><CODE>nn::gr::CTR::FrameBuffer::DepthStencilBuffer</CODE></a>
72            </th>
73<td>Class for configuring depth and stencil buffer settings.</td>
74          </tr> </table>
75      </div>
76    </a> <a name="enum" id="enum">
77<h2>Enumerated Types</h2>
78      <div class="section">
79        <table class="members">
80          <tr>
81            <td width="100"> </td>
82            <th>
83<a href="../../../../nn/gr/CTR/FrameBuffer/BlockSize.html"><CODE>BlockSize</CODE></a>
84            </th>
85<td>Enumerated type definition for setting block sizes.</td>
86          </tr> </table>
87      </div>
88    </a> <a name="constant" id="constant">
89<h2>Member Constants</h2>
90      <div class="section">
91        <table class="members">
92          <tr>
93            <td width="100">
94<span class="static_style" title="static">S</span>
95            </td>
96            <th>
97<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/COLOR_BUFFER_BIT.html"><CODE>COLOR_BUFFER_BIT</CODE></a></span>
98            </th>
99<td>Bit specifying the color buffer.</td>
100          </tr>
101          <tr>
102            <td width="100">
103<span class="static_style" title="static">S</span>
104            </td>
105            <th>
106<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/DEPTH_BUFFER_BIT.html"><CODE>DEPTH_BUFFER_BIT</CODE></a></span>
107            </th>
108<td>Bit specifying the depth buffer.</td>
109          </tr>
110          <tr>
111            <td width="100">
112<span class="static_style" title="static">S</span>
113            </td>
114            <th>
115<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/STENCIL_BUFFER_BIT.html"><CODE>STENCIL_BUFFER_BIT</CODE></a></span>
116            </th>
117<td>Bit specifying the stencil buffer.</td>
118          </tr>
119          <tr>
120            <td width="100">
121<span class="static_style" title="static">S</span>
122            </td>
123            <th>
124<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/DEPTH_STENCIL_BUFFER_BIT.html"><CODE>DEPTH_STENCIL_BUFFER_BIT</CODE></a></span>
125            </th>
126<td>Bit specifying the depth and stencil buffers.</td>
127          </tr> </table>
128      </div>
129    </a> <a name="variable" id="variable">
130<h2>Member Variables</h2>
131      <div class="section">
132        <table class="members">
133          <tr>
134            <td width="100"> </td>
135            <th>
136<span class="argument">colorBuffer</span>
137            </th>
138<td>The color buffer setting. Type is <a href="../../../../nn/gr/CTR/FrameBuffer/ColorBuffer/Overview.html"><CODE>nn::gr::CTR::FrameBuffer::ColorBuffer</CODE></a>.</td>
139          </tr>
140          <tr>
141            <td width="100"> </td>
142            <th>
143<span class="argument">depthStencilBuffer</span>
144            </th>
145<td>The depth and stencil buffer setting. Type is <a href="../../../../nn/gr/CTR/FrameBuffer/DepthStencilBuffer/Overview.html"><CODE>nn::gr::CTR::FrameBuffer::DepthStencilBuffer</CODE></a>.</td>
146          </tr>
147          <tr>
148            <td width="100"> </td>
149            <th>
150<span class="argument">width</span>
151            </th>
152<td>Width of the framebuffer. Type is <CODE>f32</CODE>.</td>
153          </tr>
154          <tr>
155            <td width="100"> </td>
156            <th>
157<span class="argument">height</span>
158            </th>
159<td>Height of the framebuffer. Type is <CODE>f32</CODE>.</td>
160          </tr> </table>
161      </div>
162    </a> <a name="function" id="function">
163<h2>Member Functions</h2>
164      <div class="section">
165        <table class="members">
166          <tr>
167            <td width="100">  </td>
168            <th>
169<a href="../../../../nn/gr/CTR/FrameBuffer/FrameBuffer.html"><CODE>FrameBuffer</CODE></a>
170            </th>
171<td>Initializes framebuffer settings to the initial values.</td>
172          </tr>
173          <tr>
174            <td width="100">  </td>
175            <th>
176<a href="../../../../nn/gr/CTR/FrameBuffer/MakeCommand.html"><CODE>MakeCommand</CODE></a>
177            </th>
178<td>Generates a command for setting the framebuffer based on information already set.</td>
179          </tr>
180          <tr>
181            <td width="100">  </td>
182            <th>
183<a href="../../../../nn/gr/CTR/FrameBuffer/MakeClearRequest.html"><CODE>MakeClearRequest</CODE></a>
184            </th>
185<td>Generates a request to clear the color buffer and the depth/stencil buffer. When the <SPAN class="argument">isSplitDrawCmdlist</SPAN> argument is <CODE>false</CODE>, you must call the <a href="../../../../nn_gx/nngxSplitDrawCmdlist.html"><CODE>nngxSplitDrawCmdlist</CODE></a> function before calling the request.</td>
186          </tr>
187          <tr>
188            <td width="100">
189<span class="static_style" title="static">S</span> </td>
190            <th>
191<a href="../../../../nn/gr/CTR/FrameBuffer/MakeClearCacheCommand.html"><CODE>MakeClearCacheCommand</CODE></a>
192            </th>
193<td>Clears the framebuffer cache. Must be called after rendering and before changing registers 0x100-0x130.</td>
194          </tr> </table>
195      </div>
196    </a>
197<h2>Revision History</h2>
198    <div class="section">
199      <dl class="history">
200        <dt>2010/10/25</dt>
201<dd>Initial version.<br />
202        </dd>
203      </dl>
204    </div>
205  <hr><p>CONFIDENTIAL</p></body>
206</html>
207