StencilOperation Enumeration

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Defines the supported stencil operations.

Namespace: Microsoft.WindowsMobile.DirectX.Direct3D
Assembly: Microsoft.WindowsMobile.DirectX (in Microsoft.WindowsMobile.DirectX.dll)

Syntax

C++

public enum class StencilOperation

Members

	Member name	Description
	Keep	Does not update the stencil buffer entry. This is the default value.
	Zero	Sets the stencil buffer entry to 0.
	Replace	Replaces the stencil buffer entry with a reference value.
	IncrementSaturation	Increments the stencil buffer entry, clamping to the maximum value.
	DecrementSaturation	Decrements the stencil buffer entry, clamping to 0.
	Invert	Inverts the bits in the stencil buffer entry.
	Increment	Increments the stencil buffer entry, wrapping to 0 if the new value exceeds the maximum value.
	Decrement	Decrements the stencil buffer entry, wrapping to the maximum value if the new value is less than 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.

Platforms

Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0