Class VkPipelineMultisampleStateCreateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer


    public class VkPipelineMultisampleStateCreateInfo
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    Contains information about multisampling as part of graphics pipeline creation.

    Valid Usage
    • sType must be 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 ceil(rasterizationSamples / 32) VkSampleMask values
    • If the sample rate shading feature is not enabled, sampleShadingEnable must be FALSE
    • If the alpha to one feature is not enabled, alphaToOneEnable must be FALSE
    • minSampleShading must be in the range [0,1]

    Member documentation

    • sType – the type of this structure. Must be: STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
    • pNext – reserved for use by extensions
    • flags – reserved for future use
    • rasterizationSamples – a VkSampleCountFlagBits specifying the number of samples per pixel used in rasterization. One of:
      SAMPLE_COUNT_16_BITSAMPLE_COUNT_1_BITSAMPLE_COUNT_2_BITSAMPLE_COUNT_32_BIT
      SAMPLE_COUNT_4_BITSAMPLE_COUNT_64_BITSAMPLE_COUNT_8_BIT
    • sampleShadingEnable – specifies that fragment shading executes per-sample if TRUE, or per-fragment if FALSE
    • minSampleShading – the minimum fraction of sample shading
    • pSampleMask – a bitmask of static coverage information that is ANDed with the coverage information generated during rasterization
    • alphaToCoverageEnable – controls whether a temporary coverage value is generated based on the alpha component of the fragment’s first color output
    • alphaToOneEnable – controls whether the alpha component of the fragment’s first color output is replaced with one

    Layout

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