VulkanHub
Function Prototype

vkCmdSetStencilCompareMask

Set stencil compare mask dynamically for a command buffer

primary / secondary
both
graphics
state

To dynamically set the stencil compare mask, call:

void vkCmdSetStencilCompareMask(
    VkCommandBuffer commandBuffer,
    VkStencilFaceFlags faceMask,
    uint32_t compareMask);
  • 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 compare mask.
  • compareMask is the new value to use as the stencil compare mask.

This command sets the stencil compare mask for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkStencilOpState::compareMask value used to create the currently active pipeline, for both front and back faces.

Valid Usage (Implicit)

VUID-vkCmdSetStencilCompareMask-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetStencilCompareMask-faceMask-parameter

faceMask must be a valid combination of VkStencilFaceFlagBits values

VUID-vkCmdSetStencilCompareMask-faceMask-requiredbitmask

faceMask must not be 0

VUID-vkCmdSetStencilCompareMask-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetStencilCompareMask-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

VUID-vkCmdSetStencilCompareMask-videocoding

This command must only be called outside of a video coding scope

Host Synchronization

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