VKCLEARVALUE(3)

NAME
VkClearValue - Structure specifying a clear value

C SPECIFICATION

The VkClearValue union is defined as:

    typedef union VkClearValue {
        VkClearColorValue           color;
        VkClearDepthStencilValue    depthStencil;
    } VkClearValue;

MEMBERS

    • color specifies the color image clear values to use when clearing a color image or attachment.

    • 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 VkRenderPassBeginInfo structure.

SEE ALSO

VkClearAttachment, VkClearColorValue, VkClearDepthStencilValue, 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.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.