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