Vulkan-Docs/doc/specs/vulkan/man/vkCmdSetDepthBounds.txt

66 lines
1.9 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkCmdSetDepthBounds(3)
======================
Name
----
vkCmdSetDepthBounds - Set the depth bounds test values for a command buffer.
C Specification
---------------
// refBegin vkCmdSetDepthBounds Set the depth bounds test values for a command buffer.
The depth bounds test conditionally disables coverage of a sample based on
the outcome of a comparison between the value latexmath:[$z_a$] in the depth
attachment at location latexmath:[$(x_f,y_f)$] (for the appropriate sample)
and a range of values. The test is enabled or disabled by the
pname:depthBoundsTestEnable member of
slink:VkPipelineDepthStencilStateCreateInfo: If the pipeline state object
is created without the ename:VK_DYNAMIC_STATE_DEPTH_BOUNDS dynamic state
enabled then the range of values used in the depth bounds test are defined
by the pname:minDepthBounds and pname:maxDepthBounds members of the
slink:VkPipelineDepthStencilStateCreateInfo structure. Otherwise, to
dynamically set the depth bounds range values call:
include::../api/protos/vkCmdSetDepthBounds.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command will be
recorded.
* pname:minDepthBounds is the lower bound of the range of depth values
used in the depth bounds test.
* pname:maxDepthBounds is the upper bound of the range.
Description
-----------
include::../validity/protos/vkCmdSetDepthBounds.txt[]
See Also
--------
slink:VkCommandBuffer
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdSetDepthBounds
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]