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>nn::gr::CTR::RenderState::StencilTest 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>Sets enable/disable for the stencil test. Always passes if disabled. The initial value is false (disabled).</td> 71 </tr> 72 <tr> 73 <td width="100"> </td> 74 <th> 75 <span class="argument">isEnableWrite</span> 76 </th> 77 <td>Enables or disables writes to the stencil buffer. The type is bool. The initial value is false (disabled).</td> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82 <span class="argument">func</span> 83 </th> 84 <td>Sets the comparison function to use in the stencil test. The type is PicaDataStencilTest. Use a PicaDataStencilTest enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_TEST_ALWAYS.</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <span class="argument">ref</span> 90 </th> 91 <td>Sets the reference value to use in the stencil test. Type is u32. The initial value is 0.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <span class="argument">mask</span> 97 </th> 98 <td>Sets the mask value to use in the stencil test. Type is u32. The initial value is 0xff.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <span class="argument">opFail</span> 104 </th> 105 <td>Sets stencil buffer value operations to be applied when the stencil test fails. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <span class="argument">opZFail</span> 111 </th> 112 <td>Sets stencil buffer value operations to be applied when the stencil test passes, but the depth test fails. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <span class="argument">opZPass</span> 118 </th> 119 <td>Sets stencil buffer value operations to be applied when the stencil test and depth test both fail. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.</td> 120 </tr> </table> 121 </div> 122 </a> <a name="function" id="function"> 123 <h2>Member Functions</h2> 124 <div class="section"> 125 <table class="members"> 126 <tr> 127 <td width="100"> </td> 128 <th> 129 <a href="../../../../../nn/gr/CTR/RenderState/StencilTest/StencilTest.html">StencilTest</a> 130 </th> 131 <td>Initializes using initial values for stencil test settings.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136 <a href="../../../../../nn/gr/CTR/RenderState/StencilTest/MakeCommand.html">MakeCommand</a> 137 </th> 138 <td>Generates drawing commands based on previously set information.</td> 139 </tr> </table> 140 </div> 141 </a> 142 <h2>Revision History</h2> 143 <div class="section"> 144 <dl class="history"> 145 <dt>2010/09/15</dt> 146 <dd>Initial version.<br /> 147 </dd> 148 </dl> 149 </div> 150 <hr><p>CONFIDENTIAL</p></body> 151</html>