RenderState.StencilFunction Property
Gets or sets the comparison function for the stencil test. The default is CompareFunction.Always.
Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)
Syntax
public CompareFunction StencilFunction { get; set; }
Property Value
Value of a CompareFunction that represents the comparison function to set or get.
Remarks
The comparison function is used to compare the reference value to a 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.
See Also
Reference
RenderState Class
RenderState Members
StencilEnable
StencilMask
StencilWriteMask
ReferenceStencil
StencilPass
StencilFail
Microsoft.Xna.Framework.Graphics Namespace
Platforms
Xbox 360, Windows XP SP2, Windows Vista