1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glStencilFuncSeparate - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glStencilFuncSeparate">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glStencilFuncSeparate — set front and/or back function and reference value for stencil testing</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glStencilFuncSeparate</strong>(</code>
</td>
<td>GLenum <var class="pdparam">face</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">func</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">ref</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">mask</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>face</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies whether front and/or back stencil state is updated.
Three symbolic constants are valid:
<code class="constant">GL_FRONT</code>,
<code class="constant">GL_BACK</code>, and
<code class="constant">GL_FRONT_AND_BACK</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>func</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the test function.
Eight symbolic constants are valid:
<code class="constant">GL_NEVER</code>,
<code class="constant">GL_LESS</code>,
<code class="constant">GL_LEQUAL</code>,
<code class="constant">GL_GREATER</code>,
<code class="constant">GL_GEQUAL</code>,
<code class="constant">GL_EQUAL</code>,
<code class="constant">GL_NOTEQUAL</code>, and
<code class="constant">GL_ALWAYS</code>. The initial value is <code class="constant">GL_ALWAYS</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>ref</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the reference value for the stencil test.
<em class="parameter"><code>ref</code></em> is clamped to the range
<math overflow="scroll">
<mfenced open="[" close="]">
<mn>0</mn>
<mrow>
<msup><mn>2</mn>
<mi mathvariant="italic">n</mi>
</msup>
<mo>-</mo>
<mn>1</mn>
</mrow>
</mfenced>
</math>,
where
<math overflow="scroll"><mi mathvariant="italic">n</mi></math>
is the number of bitplanes in the stencil buffer. The
initial value is 0.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>mask</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies a mask that is ANDed with both the reference value
and the stored stencil value when the test is done. The initial value
is all 1's.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
Stenciling,
like depth-buffering,
enables and disables drawing on a per-pixel basis.
You draw into the stencil planes using GL drawing primitives,
then render geometry and images,
using the stencil planes to mask out portions of the screen.
Stenciling is typically used in multipass rendering algorithms
to achieve special effects,
such as decals,
outlining,
and constructive solid geometry rendering.
</p>
<p>
The stencil test conditionally eliminates a pixel based on the outcome
of a comparison between the reference value
and the value in the stencil buffer.
To enable and disable the test, call <a class="citerefentry" href="glEnable.xhtml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> and <a class="citerefentry" href="glDisable.xhtml"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a>
with argument <code class="constant">GL_STENCIL_TEST</code>.
To specify actions based on the outcome of the stencil test, call
<a class="citerefentry" href="glStencilOp.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a> or
<a class="citerefentry" href="glStencilOpSeparate.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
</p>
<p>
There can be two separate sets of <em class="parameter"><code>func</code></em>, <em class="parameter"><code>ref</code></em>, and
<em class="parameter"><code>mask</code></em> parameters; one affects back-facing polygons, and the other
affects front-facing polygons as well as other non-polygon primitives.
<a class="citerefentry" href="glStencilFunc.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a> sets both front
and back stencil state to the same values, as if
<a class="citerefentry" href="glStencilFuncSeparate.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a> were called
with <em class="parameter"><code>face</code></em> set to <code class="constant">GL_FRONT_AND_BACK</code>.
</p>
<p>
<em class="parameter"><code>func</code></em> is a symbolic constant that determines the stencil comparison function.
It accepts one of eight values,
shown in the following list.
<em class="parameter"><code>ref</code></em> is an integer reference value that is used in the stencil comparison.
It is clamped to the range
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mfenced open="[" close="]">
<mml:mn>0</mml:mn>
<mml:mrow>
<mml:msup><mml:mn>2</mml:mn>
<mml:mi mathvariant="italic">n</mml:mi>
</mml:msup>
<mml:mo>-</mml:mo>
<mml:mn>1</mml:mn>
</mml:mrow>
</mml:mfenced>
</mml:math>,
where
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>
is the number of bitplanes in the stencil buffer.
<em class="parameter"><code>mask</code></em> is bitwise ANDed with both the reference value
and the stored stencil value,
with the ANDed values participating in the comparison.
</p>
<p>
If <span class="emphasis"><em>stencil</em></span> represents the value stored in the corresponding
stencil buffer location,
the following list shows the effect of each comparison function
that can be specified by <em class="parameter"><code>func</code></em>.
Only if the comparison succeeds is the pixel passed through
to the next stage in the rasterization process
(see <a class="citerefentry" href="glStencilOp.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>).
All tests treat <span class="emphasis"><em>stencil</em></span> values as unsigned integers in the range
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mfenced open="[" close="]">
<mml:mn>0</mml:mn>
<mml:mrow>
<mml:msup><mml:mn>2</mml:mn>
<mml:mi mathvariant="italic">n</mml:mi>
</mml:msup>
<mml:mo>-</mml:mo>
<mml:mn>1</mml:mn>
</mml:mrow>
</mml:mfenced>
</mml:math>,
where
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>
is the number of bitplanes in the stencil buffer.
</p>
<p>
The following values are accepted by <em class="parameter"><code>func</code></em>:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">GL_NEVER</code>
</span>
</dt>
<dd>
<p>
Always fails.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_LESS</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) < ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_LEQUAL</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) <= ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_GREATER</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) > ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_GEQUAL</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) >= ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_EQUAL</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) = ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_NOTEQUAL</code>
</span>
</dt>
<dd>
<p>
Passes if ( <em class="parameter"><code>ref</code></em> & <em class="parameter"><code>mask</code></em> ) != ( <span class="emphasis"><em>stencil</em></span> & <em class="parameter"><code>mask</code></em> ).
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ALWAYS</code>
</span>
</dt>
<dd>
<p>
Always passes.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
Initially, the stencil test is disabled.
If there is no stencil buffer,
no stencil modification can occur and it is as if
the stencil test always passes.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>func</code></em> is not one of the eight
accepted values.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument
<code class="constant">GL_STENCIL_FUNC</code>, <code class="constant">GL_STENCIL_VALUE_MASK</code>,
<code class="constant">GL_STENCIL_REF</code>, <code class="constant">GL_STENCIL_BACK_FUNC</code>,
<code class="constant">GL_STENCIL_BACK_VALUE_MASK</code>, <code class="constant">GL_STENCIL_BACK_REF</code>,
or <code class="constant">GL_STENCIL_BITS</code>
</p>
<p>
<a class="citerefentry" href="glIsEnabled.xhtml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_STENCIL_TEST</code>
</p>
</div>
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glStencilFuncSeparate</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glBlendFunc.xhtml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a>,
<a class="citerefentry" href="glDepthFunc.xhtml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
<a class="citerefentry" href="glEnable.xhtml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>,
<a class="citerefentry" href="glLogicOp.xhtml"><span class="citerefentry"><span class="refentrytitle">glLogicOp</span></span></a>,
<a class="citerefentry" href="glStencilFunc.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>,
<a class="citerefentry" href="glStencilMask.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>,
<a class="citerefentry" href="glStencilMaskSeparate.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>,
<a class="citerefentry" href="glStencilOp.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>,
<a class="citerefentry" href="glStencilOpSeparate.xhtml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2006 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|
