java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPipelineCoverageModulationStateCreateInfoNV

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineCoverageModulationStateCreateInfoNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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)
- sType must be STRUCTURE_TYPE_PIPELINE_COVERAGE_MODULATION_STATE_CREATE_INFO_NV
- flags must be 0
- coverageModulationMode must be a valid VkCoverageModulationModeNV value
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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkPipelineCoverageModulationStateCreateInfoNV.Buffer
An array of VkPipelineCoverageModulationStateCreateInfoNV structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`COVERAGEMODULATIONMODE COVERAGEMODULATIONTABLECOUNT COVERAGEMODULATIONTABLEENABLE FLAGS PCOVERAGEMODULATIONTABLE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkPipelineCoverageModulationStateCreateInfoNV(java.nio.ByteBuffer container)`	Creates a `VkPipelineCoverageModulationStateCreateInfoNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkPipelineCoverageModulationStateCreateInfoNV`	`calloc()`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated with `memCalloc`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated with `memCalloc`.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`callocStack()`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`callocStack(int capacity)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`coverageModulationMode()`	Returns the value of the `coverageModulationMode` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`coverageModulationMode(int value)`	Sets the specified value to the `coverageModulationMode` field.
`int`	`coverageModulationTableCount()`	Returns the value of the `coverageModulationTableCount` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`coverageModulationTableCount(int value)`	Sets the specified value to the `coverageModulationTableCount` field.
`boolean`	`coverageModulationTableEnable()`	Returns the value of the `coverageModulationTableEnable` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`coverageModulationTableEnable(boolean value)`	Sets the specified value to the `coverageModulationTableEnable` field.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`create()`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated with `BufferUtils`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`create(int capacity)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`create(long address)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance for the specified memory address.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance at the specified memory.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	Returns the value of the `flags` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`flags(int value)`	Sets the specified value to the `flags` field.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`malloc()`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated with `memAlloc`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated with `memAlloc`.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`mallocStack()`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`mallocStack(int capacity)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCoverageModulationStateCreateInfoNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineCoverageModulationStateCreateInfoNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineCoverageModulationStateCreateInfoNV` instance allocated on the specified `MemoryStack`.
`static int`	`ncoverageModulationMode(long struct)`	Unsafe version of `coverageModulationMode()`.
`static void`	`ncoverageModulationMode(long struct, int value)`	Unsafe version of `coverageModulationMode`.
`static int`	`ncoverageModulationTableCount(long struct)`	Unsafe version of `coverageModulationTableCount()`.
`static void`	`ncoverageModulationTableCount(long struct, int value)`	Sets the specified value to the `coverageModulationTableCount` field of the specified `struct`.
`static int`	`ncoverageModulationTableEnable(long struct)`	Unsafe version of `coverageModulationTableEnable()`.
`static void`	`ncoverageModulationTableEnable(long struct, int value)`	Unsafe version of `coverageModulationTableEnable`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static java.nio.FloatBuffer`	`npCoverageModulationTable(long struct)`	Unsafe version of `pCoverageModulationTable`.
`static void`	`npCoverageModulationTable(long struct, java.nio.FloatBuffer value)`	Unsafe version of `pCoverageModulationTable`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`java.nio.FloatBuffer`	`pCoverageModulationTable()`	Returns a `FloatBuffer` view of the data pointed to by the `pCoverageModulationTable` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`pCoverageModulationTable(java.nio.FloatBuffer value)`	Sets the address of the specified `FloatBuffer` to the `pCoverageModulationTable` field.
`long`	`pNext()`	Returns the value of the `pNext` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`pNext(long value)`	Sets the specified value to the `pNext` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`set(int sType, long pNext, int flags, int coverageModulationMode, boolean coverageModulationTableEnable, int coverageModulationTableCount, java.nio.FloatBuffer pCoverageModulationTable)`	Initializes this struct with the specified values.
`VkPipelineCoverageModulationStateCreateInfoNV`	`set(VkPipelineCoverageModulationStateCreateInfoNV src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	Returns the value of the `sType` field.
`VkPipelineCoverageModulationStateCreateInfoNV`	`sType(int value)`	Sets the specified value to the `sType` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, COVERAGEMODULATIONMODE, COVERAGEMODULATIONTABLEENABLE, COVERAGEMODULATIONTABLECOUNT, PCOVERAGEMODULATIONTABLE
    
    The struct member offsets.
- Constructor Detail
  - VkPipelineCoverageModulationStateCreateInfoNV
```
public VkPipelineCoverageModulationStateCreateInfoNV(java.nio.ByteBuffer container)
```
    Creates a VkPipelineCoverageModulationStateCreateInfoNV instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - coverageModulationMode
```
public int coverageModulationMode()
```
    Returns the value of the coverageModulationMode field.
  - coverageModulationTableEnable
```
public boolean coverageModulationTableEnable()
```
    Returns the value of the coverageModulationTableEnable field.
  - coverageModulationTableCount
```
public int coverageModulationTableCount()
```
    Returns the value of the coverageModulationTableCount field.
  - pCoverageModulationTable
```
@Nullable
public java.nio.FloatBuffer pCoverageModulationTable()
```
    Returns a FloatBuffer view of the data pointed to by the pCoverageModulationTable field.
  - sType
```
public VkPipelineCoverageModulationStateCreateInfoNV sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineCoverageModulationStateCreateInfoNV pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkPipelineCoverageModulationStateCreateInfoNV flags(int value)
```
    Sets the specified value to the flags field.
  - coverageModulationMode
```
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationMode(int value)
```
    Sets the specified value to the coverageModulationMode field.
  - coverageModulationTableEnable
```
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationTableEnable(boolean value)
```
    Sets the specified value to the coverageModulationTableEnable field.
  - coverageModulationTableCount
```
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationTableCount(int value)
```
    Sets the specified value to the coverageModulationTableCount field.
  - pCoverageModulationTable
```
public VkPipelineCoverageModulationStateCreateInfoNV pCoverageModulationTable(@Nullable
                                                                              java.nio.FloatBuffer value)
```
    Sets the address of the specified FloatBuffer to the pCoverageModulationTable field.
  - set
```
public VkPipelineCoverageModulationStateCreateInfoNV set(int sType,
                                                         long pNext,
                                                         int flags,
                                                         int coverageModulationMode,
                                                         boolean coverageModulationTableEnable,
                                                         int coverageModulationTableCount,
                                                         @Nullable
                                                         java.nio.FloatBuffer pCoverageModulationTable)
```
    Initializes this struct with the specified values.
  - set
```
public VkPipelineCoverageModulationStateCreateInfoNV set(VkPipelineCoverageModulationStateCreateInfoNV src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineCoverageModulationStateCreateInfoNV malloc()
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineCoverageModulationStateCreateInfoNV calloc()
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineCoverageModulationStateCreateInfoNV create()
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated with BufferUtils.
  - create
```
public static VkPipelineCoverageModulationStateCreateInfoNV create(long address)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPipelineCoverageModulationStateCreateInfoNV createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer malloc(int capacity)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer calloc(int capacity)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer create(int capacity)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer create(long address,
                                                                          int capacity)
```
    Create a VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer createSafe(long address,
                                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV mallocStack()
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV callocStack()
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer mallocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer callocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageModulationStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - ncoverageModulationMode
```
public static int ncoverageModulationMode(long struct)
```
    Unsafe version of coverageModulationMode().
  - ncoverageModulationTableEnable
```
public static int ncoverageModulationTableEnable(long struct)
```
    Unsafe version of coverageModulationTableEnable().
  - ncoverageModulationTableCount
```
public static int ncoverageModulationTableCount(long struct)
```
    Unsafe version of coverageModulationTableCount().
  - npCoverageModulationTable
```
@Nullable
public static java.nio.FloatBuffer npCoverageModulationTable(long struct)
```
    Unsafe version of pCoverageModulationTable.
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - ncoverageModulationMode
```
public static void ncoverageModulationMode(long struct,
                                           int value)
```
    Unsafe version of coverageModulationMode.
  - ncoverageModulationTableEnable
```
public static void ncoverageModulationTableEnable(long struct,
                                                  int value)
```
    Unsafe version of coverageModulationTableEnable.
  - ncoverageModulationTableCount
```
public static void ncoverageModulationTableCount(long struct,
                                                 int value)
```
    Sets the specified value to the coverageModulationTableCount field of the specified struct.
  - npCoverageModulationTable
```
public static void npCoverageModulationTable(long struct,
                                             @Nullable
                                             java.nio.FloatBuffer value)
```
    Unsafe version of pCoverageModulationTable.

Class VkPipelineCoverageModulationStateCreateInfoNV

Description

Valid Usage

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, COVERAGEMODULATIONMODE, COVERAGEMODULATIONTABLEENABLE, COVERAGEMODULATIONTABLECOUNT, PCOVERAGEMODULATIONTABLE

Constructor Detail

VkPipelineCoverageModulationStateCreateInfoNV

Method Detail

sizeof

sType

pNext

flags

coverageModulationMode

coverageModulationTableEnable

coverageModulationTableCount

pCoverageModulationTable

sType

pNext

flags

coverageModulationMode

coverageModulationTableEnable

coverageModulationTableCount

pCoverageModulationTable

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

ncoverageModulationMode

ncoverageModulationTableEnable

ncoverageModulationTableCount

npCoverageModulationTable

nsType

npNext

nflags

ncoverageModulationMode

ncoverageModulationTableEnable

ncoverageModulationTableCount

npCoverageModulationTable