VulkanHub
Function Prototype

vkCmdSetStencilReference

Set stencil reference value dynamically for a command buffer

primary / secondary
both
graphics
state

To dynamically set the stencil reference value, call:

void vkCmdSetStencilReference(
    VkCommandBuffer commandBuffer,
    VkStencilFaceFlags faceMask,
    uint32_t reference);
  • 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 reference value, as described above for vkCmdSetStencilCompareMask.
  • reference is the new value to use as the stencil reference value.

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

Valid Usage (Implicit)

VUID-vkCmdSetStencilReference-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetStencilReference-faceMask-parameter

faceMask must be a valid combination of VkStencilFaceFlagBits values

VUID-vkCmdSetStencilReference-faceMask-requiredbitmask

faceMask must not be 0

VUID-vkCmdSetStencilReference-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetStencilReference-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

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