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::RenderState::StencilTest</title> 49 </head> 50 <body> 51<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>::<a href="../../../../../nn/gr/CTR/RenderState/Overview.html">RenderState</a>::StencilTest</CODE> Class</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54<pre class="definition">class StencilTest</pre> 55 </div> 56<h2>Description</h2> 57 <div class="section"> 58<p>Class for setting the stencil test.</p><!-- write here --></div> 59 <a name="variable" id="variable"> 60<h2>Member Variables</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100"> </td> 65 <th> 66<span class="argument">isEnable</span> 67 </th> 68<td width="100">bool</td> 69<td>Sets enable/disable for the stencil test. Always passes if disabled. Initial value is <CODE>false</CODE> (disabled).</td> 70 </tr> 71 <tr> 72 <td width="100"> </td> 73 <th> 74<span class="argument">maskOp</span> 75 </th> 76<td width="100">bit8</td> 77<td>Mask setting for the stencil buffer. The type is <CODE>bit8</CODE>. The initial value is <CODE>0xff</CODE>. Equivalent to <CODE>glStencilMask( mask )</CODE>.</td> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82<span class="argument">func</span> 83 </th> 84<td width="100"><a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilTest.html">PicaDataStencilTest</a></td> 85<td>Sets the comparison function to use in the stencil test. The type is <a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilTest.html"><CODE>PicaDataStencilTest</CODE></a>. The initial value is PICA_DATA_STENCIL_TEST_ALWAYS. Corresponds to the <SPAN class="argument">ref</SPAN> argument of a call to <CODE>glStencilFunc(func, ref, mask)</CODE>.</td> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90<span class="argument">ref</span> 91 </th> 92<td width="100">bit32</td> 93<td>Sets the reference value to use in the stencil test. The type is <CODE>bit32</CODE>. The initial value is 0.</td> 94 </tr> 95 <tr> 96 <td width="100"> </td> 97 <th> 98<span class="argument">mask</span> 99 </th> 100<td width="100">bit32</td> 101<td>Sets the mask value to use in the stencil test. The type is <CODE>bit32</CODE>. The initial value is <CODE>0xff</CODE>. Corresponds to the <SPAN class="argument">mask</SPAN> argument of a call to <CODE>glStencilFunc(func, ref, mask)</CODE>.</td> 102 </tr> 103 <tr> 104 <td width="100"> </td> 105 <th> 106<span class="argument">opFail</span> 107 </th> 108<td width="100"><a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html">PicaDataStencilOp</a></td> 109<td>Sets stencil buffer value operations to be applied when the stencil test fails. The type is <a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html"><CODE>PicaDataStencilOp</CODE></a>. The initial value is <CODE>PICA_DATA_STENCIL_OP_KEEP</CODE>. Corresponds to the <SPAN class="argument">func</SPAN> argument of a call to <CODE>glStencilFunc(func, ref, mask)</CODE>.</td> 110 </tr> 111 <tr> 112 <td width="100"> </td> 113 <th> 114<span class="argument">opZFail</span> 115 </th> 116<td width="100"><a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html">PicaDataStencilOp</a></td> 117<td>Sets stencil buffer value operations to be applied when the stencil test passes, but the depth test fails. The type is <a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html"><CODE>PicaDataStencilOp</CODE></a>. The initial value is <CODE>PICA_DATA_STENCIL_OP_KEEP</CODE>.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<span class="argument">opZPass</span> 123 </th> 124<td width="100"><a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html">PicaDataStencilOp</a></td> 125<td>Sets stencil buffer value operations to be applied when the stencil test and depth test both fail. The type is <a href="../../../../../nn_gx_CTR_Pica/PicaDataStencilOp.html"><CODE>PicaDataStencilOp</CODE></a>. The initial value is <CODE>PICA_DATA_STENCIL_OP_KEEP</CODE>.</td> 126 </tr> </table> 127 </div> 128 </a> <a name="function" id="function"> 129<h2>Member Functions</h2> 130 <div class="section"> 131 <table class="members"> 132 <tr> 133 <td width="100"> </td> 134 <th> 135<a href="../../../../../nn/gr/CTR/RenderState/StencilTest/StencilTest.html"><CODE>StencilTest</CODE></a> 136 </th> 137<td>Initializes using initial values for stencil test settings.</td> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142<a href="../../../../../nn/gr/CTR/RenderState/StencilTest/MakeCommand.html"><CODE>MakeCommand</CODE></a> 143 </th> 144<td>Generates a rendering command based on information already set.</td> 145 </tr> 146 <tr> 147 <td width="100"> 148<span class="static_style" title="static">S</span> </td> 149 <th> 150<a href="../../../../../nn/gr/CTR/RenderState/StencilTest/MakeDisableCommand.html"><CODE>MakeDisableCommand</CODE></a> 151 </th> 152<td>Generates commands to disable stencil tests.</td> 153 </tr> </table> 154 </div> 155 </a> 156<h2>Revision History</h2> 157 <div class="section"> 158 <dl class="history"> 159 <dt>2010/09/15</dt> 160<dd>Initial version.<br /> 161 </dd> 162 </dl> 163 </div> 164 <hr><p>CONFIDENTIAL</p></body> 165</html> 166