StencilOperation Enumeration
|
Language: |
Note: This documentation is preliminary and is subject to change.
Defines the supported stencil operations.
Definition
Visual Basic .NET |
Public Enum StencilOperation |
C# |
public enum StencilOperation |
Managed C++ |
__value public enum StencilOperation |
JScript .NET |
public enum StencilOperation |
Members
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. |
Remarks
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.2902.0,
Culture=neutral,
PublicKeyToken=31bf3856ad364e35 |
© 2004 Microsoft Corporation. All rights reserved. Terms of use.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center