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