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><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/gr/Overview.html">gr</a>::<a href="../../../../nn/gr/CTR/Overview.html">CTR</a>::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 width="100">const <a href="../../../../nn_types/u32.html">u32</a></td> 102<td>Bit specifying the color buffer.</td> 103 </tr> 104 <tr> 105 <td width="100"> 106<span class="static_style" title="static">S</span> 107 </td> 108 <th> 109<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/DEPTH_BUFFER_BIT.html"><CODE>DEPTH_BUFFER_BIT</CODE></a></span> 110 </th> 111<td width="100">const <a href="../../../../nn_types/u32.html">u32</a></td> 112<td>Bit specifying the depth buffer.</td> 113 </tr> 114 <tr> 115 <td width="100"> 116<span class="static_style" title="static">S</span> 117 </td> 118 <th> 119<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/STENCIL_BUFFER_BIT.html"><CODE>STENCIL_BUFFER_BIT</CODE></a></span> 120 </th> 121<td width="100">const <a href="../../../../nn_types/u32.html">u32</a></td> 122<td>Bit specifying the stencil buffer.</td> 123 </tr> 124 <tr> 125 <td width="100"> 126<span class="static_style" title="static">S</span> 127 </td> 128 <th> 129<span class="argument"><a href="../../../../nn/gr/CTR/FrameBuffer/DEPTH_STENCIL_BUFFER_BIT.html"><CODE>DEPTH_STENCIL_BUFFER_BIT</CODE></a></span> 130 </th> 131<td width="100">const <a href="../../../../nn_types/u32.html">u32</a></td> 132<td>Bit specifying the depth and stencil buffers.</td> 133 </tr> </table> 134 </div> 135 </a> <a name="variable" id="variable"> 136<h2>Member Variables</h2> 137 <div class="section"> 138 <table class="members"> 139 <tr> 140 <td width="100"> </td> 141 <th> 142<span class="argument">colorBuffer</span> 143 </th> 144<td width="100"><a href="../../../../nn/gr/CTR/FrameBuffer/ColorBuffer/Overview.html"><CODE>ColorBuffer</CODE></a></td> 145<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> 146 </tr> 147 <tr> 148 <td width="100"> </td> 149 <th> 150<span class="argument">depthStencilBuffer</span> 151 </th> 152<td width="100"><a href="../../../../nn/gr/CTR/FrameBuffer/DepthStencilBuffer/Overview.html"><CODE>DepthStencilBuffer</CODE></a></td> 153<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> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158<span class="argument">width</span> 159 </th> 160<td width="100"><a href="../../../../nn_types/s32.html">s32</a></td> 161<td>Width of the framebuffer. Type is <CODE>f32</CODE>.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166<span class="argument">height</span> 167 </th> 168<td width="100"><a href="../../../../nn_types/s32.html">s32</a></td> 169<td>Height of the framebuffer. Type is <CODE>f32</CODE>.</td> 170 </tr> </table> 171 </div> 172 </a> <a name="function" id="function"> 173<h2>Member Functions</h2> 174 <div class="section"> 175 <table class="members"> 176 <tr> 177 <td width="100"> </td> 178 <th> 179<a href="../../../../nn/gr/CTR/FrameBuffer/FrameBuffer.html"><CODE>FrameBuffer</CODE></a> 180 </th> 181<td>Initializes framebuffer settings to the initial values.</td> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186<a href="../../../../nn/gr/CTR/FrameBuffer/MakeCommand.html"><CODE>MakeCommand</CODE></a> 187 </th> 188<td>Generates a command for setting the framebuffer based on information already set.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193<a href="../../../../nn/gr/CTR/FrameBuffer/MakeClearRequest.html"><CODE>MakeClearRequest</CODE></a> 194 </th> 195<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> 196 </tr> 197 <tr> 198 <td width="100"> 199<span class="static_style" title="static">S</span> </td> 200 <th> 201<a href="../../../../nn/gr/CTR/FrameBuffer/MakeClearCacheCommand.html"><CODE>MakeClearCacheCommand</CODE></a> 202 </th> 203<td>Clears the framebuffer cache. Must be called after rendering and before changing registers 0x100-0x130.</td> 204 </tr> </table> 205 </div> 206 </a> 207<h2>Revision History</h2> 208 <div class="section"> 209 <dl class="history"> 210 <dt>2010/10/25</dt> 211<dd>Initial version.<br /> 212 </dd> 213 </dl> 214 </div> 215 <hr><p>CONFIDENTIAL</p></body> 216</html>