VKPIPELINEMULTISAMPL(3)

NAME
VkPipelineMultisampleStateCreateInfo - Structure specifying parameters of a newly created pipeline multisample state

C SPECIFICATION

The VkPipelineMultisampleStateCreateInfo structure is defined as:

    typedef struct VkPipelineMultisampleStateCreateInfo {
        VkStructureType                          sType;
        const void*                              pNext;
        VkPipelineMultisampleStateCreateFlags    flags;
        VkSampleCountFlagBits                    rasterizationSamples;
        VkBool32                                 sampleShadingEnable;
        float                                    minSampleShading;
        const VkSampleMask*                      pSampleMask;
        VkBool32                                 alphaToCoverageEnable;
        VkBool32                                 alphaToOneEnable;
    } VkPipelineMultisampleStateCreateInfo;

MEMBERS

    • sType is the type of this structure.

    • pNext is NULL or a pointer to an extension-specific structure.

    • flags is reserved for future use.

    • rasterizationSamples is a VkSampleCountFlagBits specifying the number of samples per pixel used in rasterization.

    • sampleShadingEnable specifies that fragment shading executes per-sample if VK_TRUE, or per-fragment if VK_FALSE, as described in Sample Shading.

    • minSampleShading is the minimum fraction of sample shading, as described in Sample Shading.

    • pSampleMask is a bitmask of static coverage information that is ANDed with the coverage information generated during rasterization, as described in Sample Mask.

    • alphaToCoverageEnable controls whether a temporary coverage value is generated based on the alpha component of the fragment’s first color output as specified in the Multisample Coverage section.

    • alphaToOneEnable controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO

    • pNext must be NULL

    • flags must be 0

    • rasterizationSamples must be a valid VkSampleCountFlagBits value

    • If pSampleMask is not NULL, pSampleMask must be a pointer to an array of [ $eil$ ] VkSampleMask values

    • If the sample rate shading feature is not enabled, sampleShadingEnable must be VK_FALSE

    • If the alpha to one feature is not enabled, alphaToOneEnable must be VK_FALSE

    • minSampleShading must be in the range [ $[0,1]$ ]

SEE ALSO

VkBool32, VkGraphicsPipelineCreateInfo, VkPipelineMultisampleStateCreateFlags, VkSampleCountFlagBits, VkSampleMask, VkStructureType

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.