Function Prototype
vkCmdSetDepthWriteEnable
Set depth write enable dynamically for a command buffer
To dynamically set the depth write enable, call:
void vkCmdSetDepthWriteEnable(
VkCommandBuffer commandBuffer,
VkBool32 depthWriteEnable);
pub fn cmd_set_depth_write_enable(
command_buffer: vk::CommandBuffer,
depth_write_enable: vk::Bool32,
);
void vkCmdSetDepthWriteEnableEXT(
VkCommandBuffer commandBuffer,
VkBool32 depthWriteEnable);
pub fn cmd_set_depth_write_enable_ext(
command_buffer: vk::CommandBuffer,
depth_write_enable: vk::Bool32,
);
commandBufferis the command buffer into which the command will be recorded.depthWriteEnablespecifies 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
extendedDynamicStatefeature is enabled - the
shaderObjectfeature is enabled - the value of VkApplicationInfo::
apiVersionused to create the VkInstance parent ofcommandBufferis greater than or equal to Version 1.3
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 VK_QUEUE_GRAPHICS_BIT operations
VUID-vkCmdSetDepthWriteEnable-videocoding
This command must only be called outside of a video coding scope
Host Synchronization
- Host access to
commandBuffermust be externally synchronized - Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized
Parent
VK_VERSION_1_3Type
Function Prototype
Command Buffer Level
primarysecondary
Queue Types
VK_QUEUE_GRAPHICS_BIT
Command Type
state