VKCOLORCOMPONENTFLAG(3)

NAME
VkColorComponentFlagBits - Bitmask controlling which components are written to the framebuffer

C SPECIFICATION

The colorWriteMask member of VkPipelineColorBlendAttachmentState determines whether the final color values [ $R, G, B$ ] and [ $A$ ] are written to the framebuffer attachment. colorWriteMask is any combination of the following bits:

    typedef enum VkColorComponentFlagBits {
        VK_COLOR_COMPONENT_R_BIT = 0x00000001,
        VK_COLOR_COMPONENT_G_BIT = 0x00000002,
        VK_COLOR_COMPONENT_B_BIT = 0x00000004,
        VK_COLOR_COMPONENT_A_BIT = 0x00000008,
    } VkColorComponentFlagBits;

DESCRIPTION

If VK_COLOR_COMPONENT_R_BIT is set, then the [ $R$ ] value is written to color attachment for the appropriate sample, otherwise the value in memory is unmodified. The VK_COLOR_COMPONENT_G_BIT, VK_COLOR_COMPONENT_B_BIT, and VK_COLOR_COMPONENT_A_BIT bits similarly control writing of the [ $G, B,$ ] and [ $A$ ] values. The colorWriteMask is applied regardless of whether blending is enabled.

SEE ALSO

VkColorComponentFlags

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkColorComponentFlagBits

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.