VKPIPELINECOLORBLEND(3)

NAME
VkPipelineColorBlendAttachmentState - Structure specifying a pipeline color blend attachment state

C SPECIFICATION

The VkPipelineColorBlendAttachmentState structure is defined as:

    typedef struct VkPipelineColorBlendAttachmentState {
        VkBool32                 blendEnable;
        VkBlendFactor            srcColorBlendFactor;
        VkBlendFactor            dstColorBlendFactor;
        VkBlendOp                colorBlendOp;
        VkBlendFactor            srcAlphaBlendFactor;
        VkBlendFactor            dstAlphaBlendFactor;
        VkBlendOp                alphaBlendOp;
        VkColorComponentFlags    colorWriteMask;
    } VkPipelineColorBlendAttachmentState;

MEMBERS

    • blendEnable controls whether blending is enabled for the corresponding color attachment. If blending is not enabled, the source fragment’s color for that attachment is passed through unmodified.

    • srcColorBlendFactor selects which blend factor is used to determine the source factors (Sr,Sg,Sb).

    • dstColorBlendFactor selects which blend factor is used to determine the destination factors (Dr,Dg,Db).

    • colorBlendOp selects which blend operation is used to calculate the RGB values to write to the color attachment.

    • srcAlphaBlendFactor selects which blend factor is used to determine the source factor Sa.

    • dstAlphaBlendFactor selects which blend factor is used to determine the destination factor Da.

    • alphaBlendOp selects which blend operation is use to calculate the alpha values to write to the color attachment.

    • colorWriteMask is a bitmask selecting which of the R, G, B, and/or A components are enabled for writing, as described later in this chapter.

DESCRIPTION
Valid Usage

    • If the dual source blending feature is not enabled, srcColorBlendFactor must not be VK_BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_ALPHA, or VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

    • If the dual source blending feature is not enabled, dstColorBlendFactor must not be VK_BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_ALPHA, or VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

    • If the dual source blending feature is not enabled, srcAlphaBlendFactor must not be VK_BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_ALPHA, or VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

    • If the dual source blending feature is not enabled, dstAlphaBlendFactor must not be VK_BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_ALPHA, or VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
Valid Usage (Implicit)

    • srcColorBlendFactor must be a valid VkBlendFactor value

    • dstColorBlendFactor must be a valid VkBlendFactor value

    • colorBlendOp must be a valid VkBlendOp value

    • srcAlphaBlendFactor must be a valid VkBlendFactor value

    • dstAlphaBlendFactor must be a valid VkBlendFactor value

    • alphaBlendOp must be a valid VkBlendOp value

    • colorWriteMask must be a valid combination of VkColorComponentFlagBits values

SEE ALSO

VkBlendFactor, VkBlendOp, VkBool32, VkColorComponentFlags, VkPipelineColorBlendStateCreateInfo

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.