vkCmdSetStencilOpEXT(3)

C Specification

To dynamically set the stencil operations, call:

// Provided by VK_EXT_extended_dynamic_state
void vkCmdSetStencilOpEXT(
    VkCommandBuffer                             commandBuffer,
    VkStencilFaceFlags                          faceMask,
    VkStencilOp                                 failOp,
    VkStencilOp                                 passOp,
    VkStencilOp                                 depthFailOp,
    VkCompareOp                                 compareOp);

Parameters

commandBuffer is the command buffer into which the command will be recorded.
faceMask is a bitmask of VkStencilFaceFlagBits specifying the set of stencil state for which to update the stencil operation.
failOp is a VkStencilOp value specifying the action performed on samples that fail the stencil test.
passOp is a VkStencilOp value specifying the action performed on samples that pass both the depth and stencil tests.
depthFailOp is a VkStencilOp value specifying the action performed on samples that pass the stencil test and fail the depth test.
compareOp is a VkCompareOp value specifying the comparison operator used in the stencil test.

Description

This command sets the state for a given draw when the graphics pipeline is created with VK_DYNAMIC_STATE_STENCIL_OP_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates.

Valid Usage

VUID-vkCmdSetStencilOpEXT-None-03351
The extendedDynamicState feature must be enabled

Valid Usage (Implicit)

VUID-vkCmdSetStencilOpEXT-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdSetStencilOpEXT-faceMask-parameter
faceMask must be a valid combination of VkStencilFaceFlagBits values
VUID-vkCmdSetStencilOpEXT-faceMask-requiredbitmask
faceMask must not be 0
VUID-vkCmdSetStencilOpEXT-failOp-parameter
failOp must be a valid VkStencilOp value
VUID-vkCmdSetStencilOpEXT-passOp-parameter
passOp must be a valid VkStencilOp value
VUID-vkCmdSetStencilOpEXT-depthFailOp-parameter
depthFailOp must be a valid VkStencilOp value
VUID-vkCmdSetStencilOpEXT-compareOp-parameter
compareOp must be a valid VkCompareOp value
VUID-vkCmdSetStencilOpEXT-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdSetStencilOpEXT-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support graphics operations

Host Synchronization

Host access to commandBuffer must be externally synchronized
Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized