vkCmdSetDepthTestEnable(3)

Name

vkCmdSetDepthTestEnable - Set depth test enable dynamically for a command buffer

C Specification

Todynamically enable or disable the depthtest, call:

// Provided by VK_VERSION_1_3void vkCmdSetDepthTestEnable(    VkCommandBuffer                             commandBuffer,    VkBool32                                    depthTestEnable);

// Provided by VK_EXT_extended_dynamic_state, VK_EXT_shader_object// Equivalent to vkCmdSetDepthTestEnablevoid vkCmdSetDepthTestEnableEXT(    VkCommandBuffer                             commandBuffer,    VkBool32                                    depthTestEnable);

Parameters

commandBuffer is the command buffer into which the command will berecorded.
depthTestEnable specifies if the depth test is enabled.

Description

This command sets the depth test enable for subsequent drawing commandswhen drawing usingshader objects, orwhen the graphics pipeline is created withVK_DYNAMIC_STATE_DEPTH_TEST_ENABLE set inVkPipelineDynamicStateCreateInfo::pDynamicStates.Otherwise, this state is specified by theVkPipelineDepthStencilStateCreateInfo::depthTestEnable valueused to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetDepthTestEnable-None-08971
At least one of the followingmust be true:
- theextendedDynamicStatefeature is enabled
- theshaderObject feature is enabled
- the value ofVkApplicationInfo::apiVersion used to createtheVkInstance parent ofcommandBuffer is greater than orequal to Version 1.3

Valid Usage (Implicit)

VUID-vkCmdSetDepthTestEnable-commandBuffer-parameter
commandBuffermust be a validVkCommandBuffer handle
VUID-vkCmdSetDepthTestEnable-commandBuffer-recording
commandBuffermust be in therecording state
VUID-vkCmdSetDepthTestEnable-commandBuffer-cmdpool
TheVkCommandPool thatcommandBuffer was allocated frommust supportVK_QUEUE_GRAPHICS_BIT operations
VUID-vkCmdSetDepthTestEnable-videocoding
This commandmust only be called outside of a video coding scope

Host Synchronization

Host access tocommandBuffermust be externally synchronized
Host access to theVkCommandPool thatcommandBuffer was allocated frommust be externally synchronized

Command Properties

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

Conditional Rendering

vkCmdSetDepthTestEnable is not affected byconditional rendering

Document Notes

For more information, see theVulkan Specification.

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

Movatterモバイル変換