Package org.lwjgl.vulkan

Class VkPipelineCoverageModulationStateCreateInfoNV

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    public class VkPipelineCoverageModulationStateCreateInfoNV
extends Struct
implements NativeResource
    Structure specifying parameters controlling coverage modulation.
    Description

    If coverageModulationTableEnable is FALSE, then for each color sample the associated bits of the fragment's coverage are counted and divided by the number of associated bits to produce a modulation factor R in the range (0,1] (a value of zero would have been killed due to a color coverage of 0). Specifically:

    • N = value of rasterizationSamples
    • M = value of VkAttachmentDescription::samples for any color attachments
    • R = popcount(associated coverage bits) / (N / M)

    If coverageModulationTableEnable is TRUE, the value R is computed using a programmable lookup table. The lookup table has N / M elements, and the element of the table is selected by:

    • R = pCoverageModulationTable[popcount(associated coverage bits)-1]

    Note that the table does not have an entry for popcount(associated coverage bits) = 0, because such samples would have been killed.

    The values of pCoverageModulationTable may be rounded to an implementation-dependent precision, which is at least as fine as 1 / N, and clamped to [0,1].

    For each color attachment with a floating point or normalized color format, each fragment output color value is replicated to M values which can each be modulated (multiplied) by that color sample's associated value of R. Which components are modulated is controlled by coverageModulationMode.

    If this structure is not present, it is as if coverageModulationMode is COVERAGE_MODULATION_MODE_NONE_NV.

    Valid Usage
    • If coverageModulationTableEnable is TRUE, coverageModulationTableCount must be equal to the number of rasterization samples divided by the number of color samples in the subpass.
    Valid Usage (Implicit)

    Member documentation

    • sType – the type of this structure.
    • pNext – NULL or a pointer to an extension-specific structure.
    • flags – reserved for future use.
    • coverageModulationMode – controls which color components are modulated and is of type VkCoverageModulationModeNV.
    • coverageModulationTableEnable – controls whether the modulation factor is looked up from a table in pCoverageModulationTable.
    • coverageModulationTableCount – the number of elements in pCoverageModulationTable.
    • pCoverageModulationTable – a table of modulation factors containing a value for each number of covered samples.

    Layout

    
 struct VkPipelineCoverageModulationStateCreateInfoNV {
     VkStructureType sType;
     void const * pNext;
     VkPipelineCoverageModulationStateCreateFlagsNV flags;
     VkCoverageModulationModeNV coverageModulationMode;
     VkBool32 coverageModulationTableEnable;
     uint32_t coverageModulationTableCount;
     float const * pCoverageModulationTable;
 }