VkPipelineCoverageToColorStateCreateInfoNV (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineCoverageToColorStateCreateInfoNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying whether fragment coverage replaces a color.
Description

If coverageToColorEnable is TRUE, the fragment coverage information is treated as a bitmask with one bit for each sample (as in the Sample Mask section), and this bitmask replaces the first component of the color value corresponding to the fragment shader output location with Location equal to coverageToColorLocation and Index equal to zero. If the color attachment format has fewer bits than the sample coverage, the low bits of the sample coverage bitmask are taken without any clamping. If the color attachment format has more bits than the sample coverage, the high bits of the sample coverage bitmask are filled with zeros.

If Sample Shading is in use, the coverage bitmask only has bits set for samples that correspond to the fragment shader invocation that shades those samples.

This pipeline stage occurs after sample counting and before blending, and is always performed after fragment shading regardless of the setting of EarlyFragmentTests.

If coverageToColorEnable is FALSE, these operations are skipped. If this structure is not present, it is as if coverageToColorEnable is FALSE.

Valid Usage
- If coverageToColorEnable is TRUE, then the render pass subpass indicated by VkGraphicsPipelineCreateInfo::renderPass and VkGraphicsPipelineCreateInfo::subpass must have a color attachment at the location selected by coverageToColorLocation, with a VkFormat of FORMAT_R8_UINT, FORMAT_R8_SINT, FORMAT_R16_UINT, FORMAT_R16_SINT, FORMAT_R32_UINT, or FORMAT_R32_SINT
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NV
- flags must be 0
Member documentation
- sType – the type of this structure
- pNext – NULL or a pointer to an extension-specific structure
- flags – reserved for future use.
- coverageToColorEnable – controls whether the fragment coverage value replaces a fragment color output.
- coverageToColorLocation – controls which fragment shader color output value is replaced.
Layout
```
 struct VkPipelineCoverageToColorStateCreateInfoNV {
     VkStructureType sType;
     void const * pNext;
     VkPipelineCoverageToColorStateCreateFlagsNV flags;
     VkBool32 coverageToColorEnable;
     uint32_t coverageToColorLocation;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPipelineCoverageToColorStateCreateInfoNV.Buffer` An array of `VkPipelineCoverageToColorStateCreateInfoNV` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COVERAGETOCOLORENABLE` The struct member offsets.
`static int`	`COVERAGETOCOLORLOCATION` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`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 and Description
`VkPipelineCoverageToColorStateCreateInfoNV(java.nio.ByteBuffer container)` Creates a `VkPipelineCoverageToColorStateCreateInfoNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPipelineCoverageToColorStateCreateInfoNV`	`calloc()` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated with `memCalloc`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated with `memCalloc`.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`callocStack()` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`boolean`	`coverageToColorEnable()` Returns the value of the `coverageToColorEnable` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`coverageToColorEnable(boolean value)` Sets the specified value to the `coverageToColorEnable` field.
`int`	`coverageToColorLocation()` Returns the value of the `coverageToColorLocation` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`coverageToColorLocation(int value)` Sets the specified value to the `coverageToColorLocation` field.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`create()` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated with `BufferUtils`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`create(int capacity)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`create(long address)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance for the specified memory address.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`create(long address, int capacity)` Create a `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance at the specified memory.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`malloc()` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated with `memAlloc`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated with `memAlloc`.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`mallocStack()` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCoverageToColorStateCreateInfoNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineCoverageToColorStateCreateInfoNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCoverageToColorStateCreateInfoNV` instance allocated on the specified `MemoryStack`.
`static int`	`ncoverageToColorEnable(long struct)` Unsafe version of `coverageToColorEnable()`.
`static void`	`ncoverageToColorEnable(long struct, int value)` Unsafe version of `coverageToColorEnable`.
`static int`	`ncoverageToColorLocation(long struct)` Unsafe version of `coverageToColorLocation()`.
`static void`	`ncoverageToColorLocation(long struct, int value)` Unsafe version of `coverageToColorLocation`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`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`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`set(int sType, long pNext, int flags, boolean coverageToColorEnable, int coverageToColorLocation)` Initializes this struct with the specified values.
`VkPipelineCoverageToColorStateCreateInfoNV`	`set(VkPipelineCoverageToColorStateCreateInfoNV src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineCoverageToColorStateCreateInfoNV`	`sType(int value)` Sets the specified value to the `sType` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - COVERAGETOCOLORENABLE
```
public static final int COVERAGETOCOLORENABLE
```
    The struct member offsets.
  - COVERAGETOCOLORLOCATION
```
public static final int COVERAGETOCOLORLOCATION
```
    The struct member offsets.
- Constructor Detail
  - VkPipelineCoverageToColorStateCreateInfoNV
```
public VkPipelineCoverageToColorStateCreateInfoNV(java.nio.ByteBuffer container)
```
    Creates a VkPipelineCoverageToColorStateCreateInfoNV 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.
  - coverageToColorEnable
```
public boolean coverageToColorEnable()
```
    Returns the value of the coverageToColorEnable field.
  - coverageToColorLocation
```
public int coverageToColorLocation()
```
    Returns the value of the coverageToColorLocation field.
  - sType
```
public VkPipelineCoverageToColorStateCreateInfoNV sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineCoverageToColorStateCreateInfoNV pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkPipelineCoverageToColorStateCreateInfoNV flags(int value)
```
    Sets the specified value to the flags field.
  - coverageToColorEnable
```
public VkPipelineCoverageToColorStateCreateInfoNV coverageToColorEnable(boolean value)
```
    Sets the specified value to the coverageToColorEnable field.
  - coverageToColorLocation
```
public VkPipelineCoverageToColorStateCreateInfoNV coverageToColorLocation(int value)
```
    Sets the specified value to the coverageToColorLocation field.
  - set
```
public VkPipelineCoverageToColorStateCreateInfoNV set(int sType,
                                                      long pNext,
                                                      int flags,
                                                      boolean coverageToColorEnable,
                                                      int coverageToColorLocation)
```
    Initializes this struct with the specified values.
  - set
```
public VkPipelineCoverageToColorStateCreateInfoNV set(VkPipelineCoverageToColorStateCreateInfoNV src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineCoverageToColorStateCreateInfoNV malloc()
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineCoverageToColorStateCreateInfoNV calloc()
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineCoverageToColorStateCreateInfoNV create()
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated with BufferUtils.
  - create
```
public static VkPipelineCoverageToColorStateCreateInfoNV create(long address)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPipelineCoverageToColorStateCreateInfoNV createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer malloc(int capacity)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer calloc(int capacity)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer create(int capacity)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer create(long address,
                                                                       int capacity)
```
    Create a VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer createSafe(long address,
                                                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV mallocStack()
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV callocStack()
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer mallocStack(int capacity,
                                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer callocStack(int capacity,
                                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCoverageToColorStateCreateInfoNV.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().
  - ncoverageToColorEnable
```
public static int ncoverageToColorEnable(long struct)
```
    Unsafe version of coverageToColorEnable().
  - ncoverageToColorLocation
```
public static int ncoverageToColorLocation(long struct)
```
    Unsafe version of coverageToColorLocation().
  - 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.
  - ncoverageToColorEnable
```
public static void ncoverageToColorEnable(long struct,
                                          int value)
```
    Unsafe version of coverageToColorEnable.
  - ncoverageToColorLocation
```
public static void ncoverageToColorLocation(long struct,
                                            int value)
```
    Unsafe version of coverageToColorLocation.

Class VkPipelineCoverageToColorStateCreateInfoNV

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

COVERAGETOCOLORENABLE

COVERAGETOCOLORLOCATION

Constructor Detail

VkPipelineCoverageToColorStateCreateInfoNV

Method Detail

sizeof

sType

pNext

flags

coverageToColorEnable

coverageToColorLocation

sType

pNext

flags

coverageToColorEnable

coverageToColorLocation

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

ncoverageToColorEnable

ncoverageToColorLocation

nsType

npNext

nflags

ncoverageToColorEnable

ncoverageToColorLocation