D3D10_DDI_STENCIL_OP enumeration

The D3D10_DDI_STENCIL_OP enumeration type contains values that identify operations on stencil buffers in a call to the driver's CreateDepthStencilState function.

Syntax


typedef enum D3D10_DDI_STENCIL_OP { 
  D3D10_DDI_STENCIL_OP_KEEP      = 1,
  D3D10_DDI_STENCIL_OP_ZERO      = 2,
  D3D10_DDI_STENCIL_OP_REPLACE   = 3,
  D3D10_DDI_STENCIL_OP_INCR_SAT  = 4,
  D3D10_DDI_STENCIL_OP_DECR_SAT  = 5,
  D3D10_DDI_STENCIL_OP_INVERT    = 6,
  D3D10_DDI_STENCIL_OP_INCR      = 7,
  D3D10_DDI_STENCIL_OP_DECR      = 8
} D3D10_DDI_STENCIL_OP;

Constants

D3D10_DDI_STENCIL_OP_KEEP

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

D3D10_DDI_STENCIL_OP_ZERO

Set the stencil-buffer entry to 0.

D3D10_DDI_STENCIL_OP_REPLACE

Replace the stencil-buffer entry with a reference value.

D3D10_DDI_STENCIL_OP_INCR_SAT

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

D3D10_DDI_STENCIL_OP_DECR_SAT

Decrement the stencil-buffer entry, clamping to zero.

D3D10_DDI_STENCIL_OP_INVERT

Invert the bits in the stencil-buffer entry.

D3D10_DDI_STENCIL_OP_INCR

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

D3D10_DDI_STENCIL_OP_DECR

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

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3d10umddi.h (include D3d10umddi.h)

See also

CreateDepthStencilState

 

 

Send comments about this topic to Microsoft

Show: