D3DSTENCILOP
Microsoft DirectX 9.0 SDK Update (October 2004)

D3DSTENCILOP Enumerated Type


Defines stencil-buffer operations.

Syntax

typedef enum _D3DSTENCILOP {
    D3DSTENCILOP_KEEP = 1,
    D3DSTENCILOP_ZERO = 2,
    D3DSTENCILOP_REPLACE = 3,
    D3DSTENCILOP_INCRSAT = 4,
    D3DSTENCILOP_DECRSAT = 5,
    D3DSTENCILOP_INVERT = 6,
    D3DSTENCILOP_INCR = 7,
    D3DSTENCILOP_DECR = 8,
    D3DSTENCILOP_FORCE_DWORD = 0x7fffffff
} D3DSTENCILOP;

Constants

D3DSTENCILOP_KEEP

Do not update the entry in the stencil buffer. This is the default value.

D3DSTENCILOP_ZERO

Set the stencil-buffer entry to 0.

D3DSTENCILOP_REPLACE

Replace the stencil-buffer entry with a reference value.

D3DSTENCILOP_INCRSAT

Increment the stencil-buffer entry, clamping to the maximum value.

D3DSTENCILOP_DECRSAT

Decrement the stencil-buffer entry, clamping to zero.

D3DSTENCILOP_INVERT

Invert the bits in the stencil-buffer entry.

D3DSTENCILOP_INCR

Increment the stencil-buffer entry, wrapping to zero if the new value exceeds the maximum value.

D3DSTENCILOP_DECR

Decrement the stencil-buffer entry, wrapping to the maximum value if the new value is less than zero.

D3DSTENCILOP_FORCE_DWORD

Force this enumeration to compile to 32 bits in size. This value is not used.

Remarks

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

Enumerated Type Information

Headerd3d9types.h
Minimum operating systems Windows 98


© 2004 Microsoft Corporation. All rights reserved.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center.