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>nw::gfx::res::ResStencilOperation</title>
51  </head>
52  <body>
53    <h1>nw::gfx::res::ResStencilOperation Class</h1>
54    <h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class ResStencilOperation : public <a href="../../../../nw/ut/ResCommon/Overview.html">nw::ut::ResCommon&lt; ResStencilOperationData &gt;</a></pre>
57    </div>
58    <h2>Description</h2>
59    <div class="section">
60      <p>Binary resource class that represents stencil tests.</p>
61    </div>
62    <a name="enum" id="enum">
63      <h2>Enumerated Types</h2>
64      <div class="section">
65        <table class="members">
66          <tr>
67            <td width="100"> </td>
68            <th>
69              <a href="../../../../nw/gfx/res/ResStencilOperation/TestFunc.html"><CODE>TestFunc</CODE></a>
70            </th>
71            <td>The stencil test function.</td>
72          </tr>
73          <tr>
74            <td width="100"> </td>
75            <th>
76              <a href="../../../../nw/gfx/res/ResStencilOperation/StencilOp.html"><CODE>StencilOp</CODE></a>
77            </th>
78            <td>Post-test process.</td>
79          </tr> </table>
80      </div>
81    </a> <a name="function" id="function">
82      <h2>Member Functions</h2>
83      <div class="section">
84        <table class="members">
85          <tr>
86            <td width="100">  </td>
87            <th>
88              <a href="../../../../nw/gfx/res/ResStencilOperation/ResStencilOperation.html">ResStencilOperation</a>
89            </th>
90            <td>Constructor.</td>
91          </tr>
92          <tr>
93            <td width="100">  </td>
94            <th>
95              <a href="../../../../nw/gfx/res/ResStencilOperation/ref.html">ref</a>
96            </th>
97            <td>
98        </td>
99          </tr>
100          <tr>
101            <td width="100">  </td>
102            <th>
103              <a href="../../../../nw/gfx/res/ResStencilOperation/operator==.html"><CODE>operator ==</CODE></a>
104            </th>
105            <td>
106        </td>
107          </tr>
108          <tr>
109            <td width="100">  </td>
110            <th>
111              <a href="../../../../nw/gfx/res/ResStencilOperation/operator!=.html"><CODE>operator !=</CODE></a>
112            </th>
113            <td>
114        </td>
115          </tr>
116          <tr>
117            <td width="100">  </td>
118            <th>
119              <a href="../../../../nw/gfx/res/ResStencilOperation/GetCommandBuffer.html">GetCommandBuffer</a>
120            </th>
121            <td>Gets a pointer to the command buffer.</td>
122          </tr>
123          <tr>
124            <td width="100">  </td>
125            <th>
126              <a href="../../../../nw/gfx/res/ResStencilOperation/IsTestEnabled.html"><CODE>IsTestEnabled</CODE></a>
127            </th>
128            <td>Gets whether the stencil test is enabled or not.</td>
129          </tr>
130          <tr>
131            <td width="100">  </td>
132            <th>
133              <a href="../../../../nw/gfx/res/ResStencilOperation/SetTestEnabled.html"><CODE>SetTestEnabled</CODE></a>
134            </th>
135            <td>Sets whether the stencil test is enabled or not.</td>
136          </tr>
137          <tr>
138            <td width="100">  </td>
139            <th>
140              <a href="../../../../nw/gfx/res/ResStencilOperation/GetTestFunction.html">GetTestFunction</a>
141            </th>
142            <td>Gets the test function.</td>
143          </tr>
144          <tr>
145            <td width="100">  </td>
146            <th>
147              <a href="../../../../nw/gfx/res/ResStencilOperation/SetTestFunction.html">SetTestFunction</a>
148            </th>
149            <td>Sets the test function.</td>
150          </tr>
151          <tr>
152            <td width="100">  </td>
153            <th>
154              <a href="../../../../nw/gfx/res/ResStencilOperation/GetTestReference.html"><CODE>GetTestReference</CODE></a>
155            </th>
156            <td>Gets the reference value.</td>
157          </tr>
158          <tr>
159            <td width="100">  </td>
160            <th>
161              <a href="../../../../nw/gfx/res/ResStencilOperation/SetTestReference.html"><CODE>SetTestReference</CODE></a>
162            </th>
163            <td>Sets the reference value.</td>
164          </tr>
165          <tr>
166            <td width="100">  </td>
167            <th>
168              <a href="../../../../nw/gfx/res/ResStencilOperation/GetTestMask.html">GetTestMask</a>
169            </th>
170            <td>Gets the test mask.</td>
171          </tr>
172          <tr>
173            <td width="100">  </td>
174            <th>
175              <a href="../../../../nw/gfx/res/ResStencilOperation/SetTestMask.html">SetTestMask</a>
176            </th>
177            <td>Sets the test mask.</td>
178          </tr>
179          <tr>
180            <td width="100">  </td>
181            <th>
182              <a href="../../../../nw/gfx/res/ResStencilOperation/GetFailOperation.html">GetFailOperation</a>
183            </th>
184            <td>Gets the process to run on fragments that could not pass the stencil test.</td>
185          </tr>
186          <tr>
187            <td width="100">  </td>
188            <th>
189              <a href="../../../../nw/gfx/res/ResStencilOperation/SetFailOperation.html">SetFailOperation</a>
190            </th>
191            <td>Sets the process to run on fragments that could not pass the stencil test.</td>
192          </tr>
193          <tr>
194            <td width="100">  </td>
195            <th>
196              <a href="../../../../nw/gfx/res/ResStencilOperation/GetZFailOperation.html">GetZFailOperation</a>
197            </th>
198            <td>Gets the operation to run on fragments which passed the stencil test but failed the depth test.</td>
199          </tr>
200          <tr>
201            <td width="100">  </td>
202            <th>
203              <a href="../../../../nw/gfx/res/ResStencilOperation/SetZFailOperation.html">SetZFailOperation</a>
204            </th>
205            <td>Sets the operation to run on fragments which passed the stencil test but failed the depth test.</td>
206          </tr>
207          <tr>
208            <td width="100">  </td>
209            <th>
210              <a href="../../../../nw/gfx/res/ResStencilOperation/GetPassOperation.html">GetPassOperation</a>
211            </th>
212            <td>Gets the operation to run on fragments which passed the stencil test and either passed or was not given the depth test.</td>
213          </tr>
214          <tr>
215            <td width="100">  </td>
216            <th>
217              <a href="../../../../nw/gfx/res/ResStencilOperation/SetPassOperation.html">SetPassOperation</a>
218            </th>
219            <td>Sets the operation to run on fragments which passed the stencil test and either passed or was not given the depth test.</td>
220          </tr>
221          <tr>
222            <td width="100">  </td>
223            <th>
224              <a href="../../../../nw/ut/ResCommon/ptr.html">ptr</a>
225            </th>
226            <td>Returns a pointer to a binary resource structure. (Inherited from <CODE><a href="../../../../nw/ut/ResCommon/Overview.html">ResCommon</a></CODE>)</td>
227          </tr>
228          <tr>
229            <td width="100">  </td>
230            <th>
231              <a href="../../../../nw/ut/ResCommonBase/IsValid.html"><CODE>IsValid</CODE></a>
232            </th>
233            <td>Determines whether a pointer to a resource is <CODE>null</CODE>.(Inherited from <CODE><a href="../../../../nw/ut/ResCommonBase/Overview.html">ResCommonBase</a></CODE>.</td>
234          </tr>
235          <tr>
236            <td width="100">
237              <span class="static_style" title="static">S</span> </td>
238            <th>
239              <a href="../../../../nw/gfx/res/ResStencilOperation/GetClassName.html">GetClassName</a>
240            </th>
241            <td>
242        </td>
243          </tr> </table>
244      </div>
245    </a>
246    <h2>Class Hierarchy</h2>
247    <div class="section">
248      <p class="hierarchy"><a href="../../../../nw/ut/ResCommonBase/Overview.html">nw::ut::ResCommonBase</a><br />  <a href="../../../../nw/ut/ResCommon/Overview.html">nw::ut::ResCommon</a><br />    <b>nw::gfx::res::ResStencilOperation</b>
249      </p>
250    </div>
251  <hr><p>CONFIDENTIAL</p></body>
252</html>