vkCmdSetStencilWriteMask
To dynamically set the stencil write mask, call:
void vkCmdSetStencilWriteMask(
VkCommandBuffer commandBuffer,
VkStencilFaceFlags faceMask,
uint32_t writeMask);
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 write mask, as described above for vkCmdSetStencilCompareMask.writeMask
is the new value to use as the stencil write mask.
This command sets the stencil write mask for subsequent drawing commands
when drawing using shader objects, or
when the graphics pipeline is created with
VK_DYNAMIC_STATE_STENCIL_WRITE_MASK
set in
VkPipelineDynamicStateCreateInfo::pDynamicStates
.
Otherwise, this state is specified by the writeMask
value used to
create the currently active pipeline, for both
VkPipelineDepthStencilStateCreateInfo::front
and
VkPipelineDepthStencilStateCreateInfo::back
faces.
Valid Usage (Implicit)
VUID-vkCmdSetStencilWriteMask-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle
VUID-vkCmdSetStencilWriteMask-faceMask-parameter
faceMask
must be a valid combination of VkStencilFaceFlagBits values
VUID-vkCmdSetStencilWriteMask-faceMask-requiredbitmask
faceMask
must not be 0
VUID-vkCmdSetStencilWriteMask-commandBuffer-recording
commandBuffer
must be in the recording state
VUID-vkCmdSetStencilWriteMask-commandBuffer-cmdpool
The VkCommandPool
that commandBuffer
was allocated from must support graphics operations
VUID-vkCmdSetStencilWriteMask-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 ::