VulkanHub
Function Prototype

vkCmdSetStencilTestEnable

Set stencil test enable dynamically for a command buffer

To dynamically enable or disable the stencil test, call:

void vkCmdSetStencilTestEnableEXT(
    VkCommandBuffer commandBuffer,
    VkBool32 stencilTestEnable);
  • commandBuffer is the command buffer into which the command will be recorded.
  • stencilTestEnable specifies if the stencil test is enabled.

This command sets the stencil test enable for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_STENCIL_TEST_ENABLE set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineDepthStencilStateCreateInfo::stencilTestEnable value used to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetStencilTestEnable-None-08971

At least one of the following must be true:- the extendedDynamicState feature is enabled

Valid Usage (Implicit)

VUID-vkCmdSetStencilTestEnable-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetStencilTestEnable-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetStencilTestEnable-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

VUID-vkCmdSetStencilTestEnable-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 ::