vkCmdSetDepthClipEnableEXT(3)

C Specification

To dynamically set enable or disable depth clipping, call:

// Provided by VK_EXT_extended_dynamic_state3, VK_EXT_shader_object
void vkCmdSetDepthClipEnableEXT(
    VkCommandBuffer                             commandBuffer,
    VkBool32                                    depthClipEnable);

Parameters

commandBuffer is the command buffer into which the command will be recorded.
depthClipEnable specifies whether depth clipping is enabled.

Description

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 is set to the inverse of VkPipelineRasterizationStateCreateInfo::depthClampEnable if VkPipelineRasterizationDepthClipStateCreateInfoEXT is not specified.

Valid Usage

VUID-vkCmdSetDepthClipEnableEXT-None-08584
Either the extendedDynamicState3DepthClipEnable feature or the shaderObject feature or both must be 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