GraphicsDevice.ReferenceStencil Property

  • Article

Gets or sets a reference value for stencil testing. The default value is zero.

Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework.Graphics (in microsoft.xna.framework.graphics.dll)

Syntax

public int ReferenceStencil { get; set; }

Property Value

The stencil reference value.

Remarks

The reference value is compared (using the comparison function specified by StencilFunction) to the pixel data in the stencil buffer using the equation:

      ReferenceStencil StencilFunction (stencil buffer entry)

This comparison applies only to the bits marked enabled by the stencil mask. If the comparison is true, the stencil test passes and the pass operation (specified by the DepthStencilState.StencilPass Property) is performed.

See Also

Reference

GraphicsDevice Class
GraphicsDevice Members
Microsoft.Xna.Framework.Graphics Namespace

Platforms

Xbox 360, Windows 7, Windows Vista, Windows XP