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