vkCmdSetDepthClipEnableEXT(3)

# vkCmdSetDepthClipEnableEXT(3) Manual Page

## Name

vkCmdSetDepthClipEnableEXT - Specify dynamically whether depth clipping is enabled in the command buffer

Loading… please wait.

## C Specification

To dynamically set enable or disable depth clipping, call:

    // Provided by VK_EXT_extended_dynamic_state3
    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 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-extendedDynamicState3DepthClipEnable-07450
  The `extendedDynamicState3DepthClipEnable` feature 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

Command Properties

Command Buffer Levels | Render Pass Scope | Video Coding Scope | Supported Queue Types | Command Type
--- | --- | --- | --- | ---
Primary Secondary | Both | Outside | Graphics | State

## See Also

VK_EXT_extended_dynamic_state3, `VkBool32`, VkCommandBuffer

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0