VulkanHub
Function Prototype

vkCmdSetDepthWriteEnable

Set depth write enable dynamically for a command buffer

To dynamically set the depth write enable, call:

void vkCmdSetDepthWriteEnableEXT(
    VkCommandBuffer commandBuffer,
    VkBool32 depthWriteEnable);
  • commandBuffer is the command buffer into which the command will be recorded.
  • depthWriteEnable specifies if depth writes are enabled.

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

Valid Usage

VUID-vkCmdSetDepthWriteEnable-None-08971

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

Valid Usage (Implicit)

VUID-vkCmdSetDepthWriteEnable-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetDepthWriteEnable-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetDepthWriteEnable-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

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