vkCmdSetStencilOp
To dynamically set the stencil operation, call:
void vkCmdSetStencilOpEXT(
VkCommandBuffer commandBuffer,
VkStencilFaceFlags faceMask,
VkStencilOp failOp,
VkStencilOp passOp,
VkStencilOp depthFailOp,
VkCompareOp compareOp);
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.
This command sets the stencil operation for subsequent drawing commands when
when drawing using shader objects, or
when the graphics pipeline is created with VK_DYNAMIC_STATE_STENCIL_OP
set in VkPipelineDynamicStateCreateInfo::pDynamicStates
.
Otherwise, this state is specified by the corresponding
VkPipelineDepthStencilStateCreateInfo
::failOp
, passOp
,
depthFailOp
, and compareOp
values used to create the currently
active pipeline, for both front and back faces.
Valid Usage
VUID-vkCmdSetStencilOp-None-08971
At least one of the following must be true:- the extendedDynamicState
feature is enabled
- the
shaderObject
feature is enabled ::
Valid Usage (Implicit)
VUID-vkCmdSetStencilOp-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle
VUID-vkCmdSetStencilOp-faceMask-parameter
faceMask
must be a valid combination of VkStencilFaceFlagBits values
VUID-vkCmdSetStencilOp-faceMask-requiredbitmask
faceMask
must not be 0
VUID-vkCmdSetStencilOp-failOp-parameter
failOp
must be a valid VkStencilOp value
VUID-vkCmdSetStencilOp-passOp-parameter
passOp
must be a valid VkStencilOp value
VUID-vkCmdSetStencilOp-depthFailOp-parameter
depthFailOp
must be a valid VkStencilOp value
VUID-vkCmdSetStencilOp-compareOp-parameter
compareOp
must be a valid VkCompareOp value
VUID-vkCmdSetStencilOp-commandBuffer-recording
commandBuffer
must be in the recording state
VUID-vkCmdSetStencilOp-commandBuffer-cmdpool
The VkCommandPool
that commandBuffer
was allocated from must support graphics operations
VUID-vkCmdSetStencilOp-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
thatcommandBuffer
was allocated from must be externally synchronized ::