vkCmdSetDepthBounds(3)

Name

vkCmdSetDepthBounds - Set depth bounds range dynamically for a command buffer

C Specification

To dynamically set the depth bounds range, call:

// Provided by VK_VERSION_1_0
void vkCmdSetDepthBounds(
    VkCommandBuffer                             commandBuffer,
    float                                       minDepthBounds,
    float                                       maxDepthBounds);

Parameters

commandBuffer is the command buffer into which the command will be recorded.
minDepthBounds is the minimum depth bound.
maxDepthBounds is the maximum depth bound.

Description

This command sets the depth bounds range for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_DEPTH_BOUNDS set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineDepthStencilStateCreateInfo::minDepthBounds and VkPipelineDepthStencilStateCreateInfo::maxDepthBounds values used to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetDepthBounds-minDepthBounds-00600
If the VK_EXT_depth_range_unrestricted extension is not enabled minDepthBounds must be between 0.0 and 1.0, inclusive
VUID-vkCmdSetDepthBounds-maxDepthBounds-00601
If the VK_EXT_depth_range_unrestricted extension is not enabled maxDepthBounds must be between 0.0 and 1.0, inclusive
VUID-vkCmdSetDepthBounds-minDepthBounds-10912
minDepthBounds must be less than or equal to maxDepthBounds

Valid Usage (Implicit)

VUID-vkCmdSetDepthBounds-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdSetDepthBounds-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdSetDepthBounds-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_GRAPHICS_BIT operations
VUID-vkCmdSetDepthBounds-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