VulkanHub
Function Prototype

vkCmdSetDepthClipEnableEXT

Specify dynamically whether depth clipping is enabled in the command buffer
primary / secondary
both
graphics
state

To dynamically set enable or disable depth clipping, call:

void vkCmdSetDepthClipEnableEXT(
    VkCommandBuffer commandBuffer,
    VkBool32 depthClipEnable);
  • commandBuffer is the command buffer into which the command will be recorded.
  • depthClipEnable specifies whether depth clipping is enabled.

This command sets whether depth clipping is enabled or disabled for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_DEPTH_CLIP_ENABLE_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineRasterizationDepthClipStateCreateInfoEXT::depthClipEnable value used to create the currently active pipeline, or by the inverse of VkPipelineRasterizationStateCreateInfo::depthClampEnable if VkPipelineRasterizationDepthClipStateCreateInfoEXT is not specified.

Valid Usage

VUID-vkCmdSetDepthClipEnableEXT-None-09423

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

VUID-vkCmdSetDepthClipEnableEXT-depthClipEnable-07451

The depthClipEnable feature must be enabled

::

Valid Usage (Implicit)

VUID-vkCmdSetDepthClipEnableEXT-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetDepthClipEnableEXT-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetDepthClipEnableEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

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