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

58 lines
1.4 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/
VkClearDepthStencilValue(3)
===========================
Name
----
VkClearDepthStencilValue - Structure specifying a clear depth stencil value
C Specification
---------------
// refBegin VkClearDepthStencilValue - Structure specifying a clear depth stencil value
The sname:VkClearDepthStencilValue structure is defined as:
include::../structs/VkClearDepthStencilValue.txt[]
Members
-------
* pname:depth is the clear value for the depth aspect of the depth/stencil
attachment. It is a floating-point value which is automatically
converted to the attachment's format.
* pname:stencil is the clear value for the stencil aspect of the
depth/stencil attachment. It is a 32-bit integer value which is
converted to the attachment's format by taking the appropriate number of
LSBs.
Description
-----------
include::../validity/structs/VkClearDepthStencilValue.txt[]
See Also
--------
slink:VkClearValue, flink:vkCmdClearDepthStencilImage
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkClearDepthStencilValue
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]