Vulkan-Docs/doc/specs/vulkan/man/VkPipelineDepthStencilState...

68 lines
2.2 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/
VkPipelineDepthStencilStateCreateInfo(3)
========================================
Name
----
VkPipelineDepthStencilStateCreateInfo - Structure specifying parameters of a newly created pipeline depth stencil state
C Specification
---------------
// refBegin VkPipelineDepthStencilStateCreateInfo - Structure specifying parameters of a newly created pipeline depth stencil state
The sname:VkPipelineDepthStencilStateCreateInfo structure is defined as:
include::../api/structs/VkPipelineDepthStencilStateCreateInfo.txt[]
Members
-------
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:flags is reserved for future use.
* pname:depthTestEnable controls whether <<fragops-depth,depth testing>>
is enabled.
* pname:depthWriteEnable controls whether
<<fragops-depth-write,depth writes>> are enabled.
* pname:depthCompareOp is the comparison operator used in the
<<fragops-depth,depth test>>.
* pname:depthBoundsTestEnable controls whether <<fragops-dbt,depth bounds
testing>> is enabled.
* pname:stencilTestEnable controls whether <<fragops-stencil,stencil
testing>> is enabled.
* pname:front and pname:back control the parameters of the
<<fragops-stencil,stencil test>>.
* pname:minDepthBounds and pname:maxDepthBounds define the range of values
used in the <<fragops-dbt,depth bounds test>>.
Description
-----------
include::../validity/structs/VkPipelineDepthStencilStateCreateInfo.txt[]
See Also
--------
basetype:VkBool32, elink:VkCompareOp, slink:VkGraphicsPipelineCreateInfo, elink:VkPipelineDepthStencilStateCreateFlags, slink:VkStencilOpState, elink:VkStructureType
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkPipelineDepthStencilStateCreateInfo
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]