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

59 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/
VkClearValue(3)
===============
Name
----
VkClearValue - Structure specifying a clear value
C Specification
---------------
// refBegin VkClearValue - Structure specifying a clear value
The sname:VkClearValue union is defined as:
include::../api/structs/VkClearValue.txt[]
Members
-------
* pname:color specifies the color image clear values to use when
clearing a color image or attachment.
* pname:depthStencil specifies the depth and stencil clear values to use
when clearing a depth/stencil image or attachment.
Description
-----------
This union is used where part of the API requires either color or
depth/stencil clear values, depending on the attachment, and defines the
initial clear values in the slink:VkRenderPassBeginInfo structure.
include::../validity/structs/VkClearValue.txt[]
See Also
--------
slink:VkClearAttachment, slink:VkClearColorValue, slink:VkClearDepthStencilValue, slink:VkRenderPassBeginInfo
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkClearValue
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]