StencilOperation Enumeration
Defines stencil buffer operations.
Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)
Syntax
public enum StencilOperation
Members
Member name | Description | |
---|---|---|
Decrement | Decrements the stencil-buffer entry, wrapping to the maximum value if the new value is less than 0. | |
DecrementSaturation | Decrements the stencil-buffer entry, clamping to 0. | |
Increment | Increments the stencil-buffer entry, wrapping to 0 if the new value exceeds the maximum value. | |
IncrementSaturation | Increments the stencil-buffer entry, clamping to the maximum value. | |
Invert | Inverts the bits in the stencil-buffer entry. | |
Keep | Does not update the stencil-buffer entry. This is the default value. | |
Replace | Replaces the stencil-buffer entry with a reference value. | |
Zero | Sets the stencil-buffer entry to 0. |
Remarks
Stencil-buffer entries are integer values that range from 0 to 2n − 1, where n is the bit depth of the stencil buffer.
See Also
Reference
RenderState.StencilPass Property
RenderState.StencilFail Property
RenderState.StencilDepthBufferFail Property
RenderState.CounterClockwiseStencilPass Property
RenderState.CounterClockwiseStencilFail Property
RenderState.CounterClockwiseStencilDepthBufferFail Property
Microsoft.Xna.Framework.Graphics Namespace
Platforms
Xbox 360, Windows XP SP2, Windows Vista