StencilOperation Enumeration (Microsoft.DirectX.Direct3D)

Defines the supported stencil operations.


Visual Basic Public Enum StencilOperation
C# public enum StencilOperation
C++ public enum class StencilOperation
JScript public enum StencilOperation


Member Value Description
Zero 2 Sets the stencil-buffer entry to 0.
Decrement 8 Decrements the stencil-buffer entry, wrapping to the maximum value if the new value is less than 0.
Increment 7 Increments the stencil-buffer entry, wrapping to 0 if the new value exceeds the maximum value.
Invert 6 Inverts the bits in the stencil-buffer entry.
DecrementSaturation 5 Decrements the stencil-buffer entry, clamping to 0.
IncrementSaturation 4 Increments the stencil-buffer entry, clamping to the maximum value.
Keep 1 Does not update the stencil-buffer entry. This is the default value.
Replace 3 Replaces the stencil-buffer entry with a reference value.


Stencil buffer entries are integer values that range from 0 to 2n - 1, where n is the bit depth of the stencil buffer.

Enumeration Information

Namespace Microsoft.DirectX.Direct3D
Assembly Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)
Strong Name Microsoft.DirectX.Direct3D,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492