Class VkPipelineCoverageToColorStateCreateInfoNV
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If the pNext chain of VkPipelineMultisampleStateCreateInfo includes a VkPipelineCoverageToColorStateCreateInfoNV structure, then that structure controls whether the fragment coverage is substituted for a fragment color output and, if so, which output is replaced.
If coverageToColorEnable is TRUE, the coverage mask 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 coverage mask, the low bits of the sample coverage mask are taken without any clamping. If the color attachment format has more bits than the coverage mask, the high bits of the sample coverage mask are filled with zeros.
If coverageToColorEnable is FALSE, these operations are skipped. If this structure is not included in the pNext chain, it is as if coverageToColorEnable is FALSE.
Valid Usage
- If
coverageToColorEnableisTRUE, then the render pass subpass indicated byVkGraphicsPipelineCreateInfo::renderPassandVkGraphicsPipelineCreateInfo::subpassmust have a color attachment at the location selected bycoverageToColorLocation, with aVkFormatofFORMAT_R8_UINT,FORMAT_R8_SINT,FORMAT_R16_UINT,FORMAT_R16_SINT,FORMAT_R32_UINT, orFORMAT_R32_SINT
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NVflagsmust be 0
Layout
struct VkPipelineCoverageToColorStateCreateInfoNV {
VkStructureType sType();
void const * pNext();
VkPipelineCoverageToColorStateCreateFlagsNV flags();
VkBool32 coverageToColorEnable();
uint32_t coverageToColorLocation();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineCoverageToColorStateCreateInfoNVstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkPipelineCoverageToColorStateCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.booleancontrols whether the fragment coverage value replaces a fragment color output.coverageToColorEnable(boolean value) Sets the specified value to thecoverageToColorEnable()field.intcontrols which fragment shader color output value is replaced.coverageToColorLocation(int value) Sets the specified value to thecoverageToColorLocation()field.create()Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance at the specified memory.static @Nullable VkPipelineCoverageToColorStateCreateInfoNVcreateSafe(long address) static @Nullable VkPipelineCoverageToColorStateCreateInfoNV.BuffercreateSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intncoverageToColorEnable(long struct) Unsafe version ofcoverageToColorEnable().static voidncoverageToColorEnable(long struct, int value) Unsafe version ofcoverageToColorEnable.static intncoverageToColorLocation(long struct) Unsafe version ofcoverageToColorLocation().static voidncoverageToColorLocation(long struct, int value) Unsafe version ofcoverageToColorLocation.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int flags, boolean coverageToColorEnable, int coverageToColorLocation) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NVvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
COVERAGETOCOLORENABLE
public static final int COVERAGETOCOLORENABLEThe struct member offsets. -
COVERAGETOCOLORLOCATION
public static final int COVERAGETOCOLORLOCATIONThe struct member offsets.
-
-
Constructor Details
-
VkPipelineCoverageToColorStateCreateInfoNV
Creates aVkPipelineCoverageToColorStateCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer. 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineCoverageToColorStateCreateInfoNV>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
coverageToColorEnable
public boolean coverageToColorEnable()controls whether the fragment coverage value replaces a fragment color output. -
coverageToColorLocation
public int coverageToColorLocation()controls which fragment shader color output value is replaced. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NVvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
coverageToColorEnable
Sets the specified value to thecoverageToColorEnable()field. -
coverageToColorLocation
Sets the specified value to thecoverageToColorLocation()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
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated withBufferUtils. -
create
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineCoverageToColorStateCreateInfoNV.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer mallocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer callocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineCoverageToColorStateCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineCoverageToColorStateCreateInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCoverageToColorStateCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ncoverageToColorEnable
public static int ncoverageToColorEnable(long struct) Unsafe version ofcoverageToColorEnable(). -
ncoverageToColorLocation
public static int ncoverageToColorLocation(long struct) Unsafe version ofcoverageToColorLocation(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ncoverageToColorEnable
public static void ncoverageToColorEnable(long struct, int value) Unsafe version ofcoverageToColorEnable. -
ncoverageToColorLocation
public static void ncoverageToColorLocation(long struct, int value) Unsafe version ofcoverageToColorLocation.
-