vulkan-3.1.0.0: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Core10.Enums.StencilOp

Synopsis

Documentation

newtype StencilOp Source #

VkStencilOp - Stencil comparison function

Description

For purposes of increment and decrement, the stencil bits are considered as an unsigned integer.

If the stencil test fails, the sample’s coverage bit is cleared in the fragment. If there is no stencil framebuffer attachment, stencil modification cannot occur, and it is as if the stencil tests always pass.

If the stencil test passes, the writeMask member of the StencilOpState structures controls how the updated stencil value is written to the stencil framebuffer attachment.

The least significant s bits of writeMask, where s is the number of bits in the stencil framebuffer attachment, specify an integer mask. Where a 1 appears in this mask, the corresponding bit in the stencil value in the depth/stencil attachment is written; where a 0 appears, the bit is not written. The writeMask value uses either the front-facing or back-facing state based on the facingness of the fragment. Fragments generated by front-facing primitives use the front mask and fragments generated by back-facing primitives use the back mask.

See Also

StencilOpState

Constructors

StencilOp Int32 

Bundled Patterns

pattern STENCIL_OP_KEEP :: StencilOp

STENCIL_OP_KEEP keeps the current value.

pattern STENCIL_OP_ZERO :: StencilOp

STENCIL_OP_ZERO sets the value to 0.

pattern STENCIL_OP_REPLACE :: StencilOp

STENCIL_OP_REPLACE sets the value to reference.

pattern STENCIL_OP_INCREMENT_AND_CLAMP :: StencilOp

STENCIL_OP_INCREMENT_AND_CLAMP increments the current value and clamps to the maximum representable unsigned value.

pattern STENCIL_OP_DECREMENT_AND_CLAMP :: StencilOp

STENCIL_OP_DECREMENT_AND_CLAMP decrements the current value and clamps to 0.

pattern STENCIL_OP_INVERT :: StencilOp

STENCIL_OP_INVERT bitwise-inverts the current value.

pattern STENCIL_OP_INCREMENT_AND_WRAP :: StencilOp

STENCIL_OP_INCREMENT_AND_WRAP increments the current value and wraps to 0 when the maximum value would have been exceeded.

pattern STENCIL_OP_DECREMENT_AND_WRAP :: StencilOp

STENCIL_OP_DECREMENT_AND_WRAP decrements the current value and wraps to the maximum possible value when the value would go below 0.

Instances
Eq StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp

Ord StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp

Read StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp

Show StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp

Storable StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp

Zero StencilOp Source # 
Instance details

Defined in Graphics.Vulkan.Core10.Enums.StencilOp