Vulkan.Core10.Enums.CompareOp

Documentation

newtype CompareOp

VkCompareOp - Comparison operator for depth, stencil, and sampler operations

Description

• COMPARE_OP_NEVER specifies that the comparison always evaluates false.

• COMPARE_OP_LESS specifies that the comparison evaluates reference < test.
• COMPARE_OP_EQUAL specifies that the comparison evaluates reference = test.
• COMPARE_OP_LESS_OR_EQUAL specifies that the comparison evaluates reference ≤ test.
• COMPARE_OP_GREATER specifies that the comparison evaluates reference > test.
• COMPARE_OP_NOT_EQUAL specifies that the comparison evaluates reference ≠ test.
• COMPARE_OP_GREATER_OR_EQUAL specifies that the comparison evaluates reference ≥ test.
• COMPARE_OP_ALWAYS specifies that the comparison always evaluates true.

Comparison operators are used for:

• The Depth Compare Operation operator for a sampler, specified by SamplerCreateInfo::compareOp.
• The stencil comparison operator for the stencil test, specified by cmdSetStencilOp::compareOp or StencilOpState::compareOp.
• The Depth Comparison operator for the depth test, specified by cmdSetDepthCompareOp::depthCompareOp or PipelineDepthStencilStateCreateInfo::depthCompareOp.

Each such use describes how the reference and test values for that comparison are determined.

See Also

VK_VERSION_1_0, PipelineDepthStencilStateCreateInfo, SamplerCreateInfo, StencilOpState, cmdSetDepthCompareOp, cmdSetDepthCompareOpEXT, cmdSetStencilOp, cmdSetStencilOpEXT

Constructors

CompareOp Int32

Bundled Patterns

pattern COMPARE_OP_NEVER :: CompareOp

pattern COMPARE_OP_LESS :: CompareOp

pattern COMPARE_OP_EQUAL :: CompareOp

pattern COMPARE_OP_LESS_OR_EQUAL :: CompareOp

pattern COMPARE_OP_GREATER :: CompareOp

pattern COMPARE_OP_NOT_EQUAL :: CompareOp

pattern COMPARE_OP_GREATER_OR_EQUAL :: CompareOp

pattern COMPARE_OP_ALWAYS :: CompareOp

Instances

Storable CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

sizeOf :: CompareOp -> Int

alignment :: CompareOp -> Int

peekElemOff :: Ptr CompareOp -> Int -> IO CompareOp

pokeElemOff :: Ptr CompareOp -> Int -> CompareOp -> IO ()

peekByteOff :: Ptr b -> Int -> IO CompareOp

pokeByteOff :: Ptr b -> Int -> CompareOp -> IO ()

peek :: Ptr CompareOp -> IO CompareOp

poke :: Ptr CompareOp -> CompareOp -> IO ()

Read CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

readsPrec :: Int -> ReadS CompareOp

readList :: ReadS [CompareOp]

readPrec :: ReadPrec CompareOp

readListPrec :: ReadPrec [CompareOp]

Show CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

showsPrec :: Int -> CompareOp -> ShowS

show :: CompareOp -> String

showList :: [CompareOp] -> ShowS

Eq CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

(==) :: CompareOp -> CompareOp -> Bool

(/=) :: CompareOp -> CompareOp -> Bool

Ord CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

compare :: CompareOp -> CompareOp -> Ordering

(<) :: CompareOp -> CompareOp -> Bool

(<=) :: CompareOp -> CompareOp -> Bool

(>) :: CompareOp -> CompareOp -> Bool

(>=) :: CompareOp -> CompareOp -> Bool

max :: CompareOp -> CompareOp -> CompareOp

min :: CompareOp -> CompareOp -> CompareOp

Zero CompareOp

Defined in Vulkan.Core10.Enums.CompareOp

Methods

zero :: CompareOp