DepthStencilState.StencilFunction Property
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Gets or sets the comparison function for the stencil test. The default is Always.
Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework.Graphics (in Microsoft.Xna.Framework.Graphics.dll)
Syntax
'Declaration
Public Property StencilFunction As CompareFunction
public CompareFunction StencilFunction { get; set; }
Property Value
Type: Microsoft.Xna.Framework.Graphics.CompareFunction
A CompareFunction value indicating the comparison function to get or set.
Remarks
The comparison function is used to compare the reference value (stored in the ReferenceStencil property) to the stencil buffer entry of a pixel. This can be illustrated by a simple equation:
ReferenceStencil StencilFunction (stencil buffer entry)
This comparison applies only to the bits in the reference value and stencil buffer entry that are set in the stencil mask by this property. If the comparison is true, the stencil test passes and the pass operation (specified by the StencilPass property) is performed.
Version Information
Silverlight
Supported in: 5
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.