StencilFunc - Revision history

Admin: Created page with "= Action = Set function and reference value for stencil testing.
2014-12-12T20:59:16Z

Created page with "= <span class="f_Header">Action</span> = Set function and reference value for stencil testing. <span style="font-family: Arial;"> </span> <span style="font-fam..."

New page
= <span class="f_Header">Action</span> =

Set function and reference value for stencil testing.

 

<span style="font-family: Arial;"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">Syntax</span> =

<span class="f_Syntax">StencilFunc </span>func, ref, mask

<span class="f_Syntax"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">Remarks</span> =
<div style="padding: 0px; margin: 0px;">
{| cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="65" style="width: 65px; border: 2px solid rgb(0, 0, 0);" |
func

| valign="top" width="767" style="width: 767px; border: 2px solid rgb(0, 0, 0);" |
Specifies the test function, one of <span style="font-weight: bold;">NEVER</span>, <span style="font-weight: bold;">LESS</span>, <span style="font-weight: bold;">LEQUAL</span>, <span style="font-weight: bold;">GREATER</span>, <span style="font-weight: bold;">GEQUAL</span>, <span style="font-weight: bold;">EQUAL</span>, <span style="font-weight: bold;">NOTEQUAL</span>, or<span style="font-weight: bold;">ALWAYS</span>. The initial value is ALWAYS.

|- style="vertical-align: top;"
| valign="top" width="65" style="width: 65px; border: 2px solid rgb(0, 0, 0);" |
ref

| valign="top" width="767" style="width: 767px; border: 2px solid rgb(0, 0, 0);" |
Specifies the reference value for the stencil test, range <span style="font-weight: bold;">0</span> to <span style="font-weight: bold;">255</span>, the initial value is 0

|- style="vertical-align: top;"
| valign="top" width="65" style="width: 65px; border: 2px solid rgb(0, 0, 0);" |
mask

| valign="top" width="767" style="width: 767px; border: 2px solid rgb(0, 0, 0);" |
Specifies a mask that is ANDed with the reference value and the stored stencil value, range <span style="font-weight: bold;">0</span> to <span style="font-weight: bold;">255</span>

The initial value is 255

|}
</div>
 

Stencil test rejects or accepts pixels depending on the result of the test function defined in <span style="color: rgb(128, 0, 128);">func</span> parameter, which operates

on the current value in the stencil buffer against the reference value.

 

= <span class="f_Header">See also</span> =

[[StencilOp]], [[StencilMask]]

 

 

= <span class="f_Header">Example</span> =

<source lang="bascomavr">
' Pseudocode

' Draw two points, incrementing stencil at each pixel, then draw the pixels with value 2 in red
StencilOp INCR, INCR
PointSize 760
Begin_G POINTS
Vertex2II 50, 60, 0, 0
Vertex2II 110, 60, 0, 0
StencilFunc EQUAL, 2, 255
ColorRGB 100, 0, 0
Vertex2II 80, 60, 0, 0
</source> [[File:Clip0085.png|center|clip0085.png]]

<br/>{{Languages}}

[[Category:FT800 Commands]]