Package org.lwjgl.vulkan

Class VkPipelineCoverageReductionStateCreateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkPipelineCoverageReductionStateCreateInfoNV

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineCoverageReductionStateCreateInfoNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Structure specifying parameters controlling coverage reduction.

Description

If this structure is not included in the pNext chain, or if the extension is not enabled, the default coverage reduction mode is inferred as follows:

• If the VK_NV_framebuffer_mixed_samples extension is enabled, then it is as if the coverageReductionMode is COVERAGE_REDUCTION_MODE_MERGE_NV.
• If the VK_AMD_mixed_attachment_samples extension is enabled, then it is as if the coverageReductionMode is COVERAGE_REDUCTION_MODE_TRUNCATE_NV.
• If both VK_NV_framebuffer_mixed_samples and VK_AMD_mixed_attachment_samples are enabled, then the default coverage reduction mode is implementation-dependent.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV
• flags must be 0
• coverageReductionMode must be a valid VkCoverageReductionModeNV value

Layout

 struct VkPipelineCoverageReductionStateCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkPipelineCoverageReductionStateCreateFlagsNV flags();
     VkCoverageReductionModeNV coverageReductionMode();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineCoverageReductionStateCreateInfoNV.Buffer	An array of VkPipelineCoverageReductionStateCreateInfoNV structs.

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

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineCoverageReductionStateCreateInfoNV	calloc()	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with memCalloc.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with memCalloc.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineCoverageReductionStateCreateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineCoverageReductionStateCreateInfoNV	callocStack()	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	coverageReductionMode()	a VkCoverageReductionModeNV value controlling how color sample coverage is generated from pixel coverage.
VkPipelineCoverageReductionStateCreateInfoNV	coverageReductionMode(int value)	Sets the specified value to the coverageReductionMode() field.
static VkPipelineCoverageReductionStateCreateInfoNV	create()	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with BufferUtils.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	create(int capacity)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkPipelineCoverageReductionStateCreateInfoNV	create(long address)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance for the specified memory address.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance at the specified memory.
static VkPipelineCoverageReductionStateCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkPipelineCoverageReductionStateCreateInfoNV	flags(int value)	Sets the specified value to the flags() field.
static VkPipelineCoverageReductionStateCreateInfoNV	malloc()	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with memAlloc.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with memAlloc.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkPipelineCoverageReductionStateCreateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated on the specified MemoryStack.
static VkPipelineCoverageReductionStateCreateInfoNV	mallocStack()	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineCoverageReductionStateCreateInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ncoverageReductionMode(long struct)	Unsafe version of coverageReductionMode().
static void	ncoverageReductionMode(long struct, int value)	Unsafe version of coverageReductionMode.
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()	NULL or a pointer to a structure extending this structure.
VkPipelineCoverageReductionStateCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineCoverageReductionStateCreateInfoNV	set(int sType, long pNext, int flags, int coverageReductionMode)	Initializes this struct with the specified values.
VkPipelineCoverageReductionStateCreateInfoNV	set(VkPipelineCoverageReductionStateCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	the type of this structure.
VkPipelineCoverageReductionStateCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkPipelineCoverageReductionStateCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV 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, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

STYPE, PNEXT, FLAGS, COVERAGEREDUCTIONMODE

The struct member offsets.

Constructor Detail

VkPipelineCoverageReductionStateCreateInfoNV

public VkPipelineCoverageReductionStateCreateInfoNV(java.nio.ByteBuffer container)

Creates a VkPipelineCoverageReductionStateCreateInfoNV 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()

the type of this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

coverageReductionMode

public int coverageReductionMode()

a VkCoverageReductionModeNV value controlling how color sample coverage is generated from pixel coverage.

sType

public VkPipelineCoverageReductionStateCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineCoverageReductionStateCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV value to the sType() field.

pNext

public VkPipelineCoverageReductionStateCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkPipelineCoverageReductionStateCreateInfoNV flags(int value)

Sets the specified value to the flags() field.

coverageReductionMode

public VkPipelineCoverageReductionStateCreateInfoNV coverageReductionMode(int value)

Sets the specified value to the coverageReductionMode() field.

set

public VkPipelineCoverageReductionStateCreateInfoNV set(int sType,
                                                        long pNext,
                                                        int flags,
                                                        int coverageReductionMode)

Initializes this struct with the specified values.

set

public VkPipelineCoverageReductionStateCreateInfoNV set(VkPipelineCoverageReductionStateCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineCoverageReductionStateCreateInfoNV malloc()

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkPipelineCoverageReductionStateCreateInfoNV calloc()

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkPipelineCoverageReductionStateCreateInfoNV create()

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated with BufferUtils.

create

public static VkPipelineCoverageReductionStateCreateInfoNV create(long address)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineCoverageReductionStateCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer malloc(int capacity)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer calloc(int capacity)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer create(int capacity)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer create(long address,
                                                                         int capacity)

Create a VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer createSafe(long address,
                                                                             int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer mallocStack(int capacity,
                                                                              org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer callocStack(int capacity,
                                                                              org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkPipelineCoverageReductionStateCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineCoverageReductionStateCreateInfoNV calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer malloc(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

public static VkPipelineCoverageReductionStateCreateInfoNV.Buffer calloc(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineCoverageReductionStateCreateInfoNV.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().

ncoverageReductionMode

public static int ncoverageReductionMode(long struct)

Unsafe version of coverageReductionMode().

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.

ncoverageReductionMode

public static void ncoverageReductionMode(long struct,
                                          int value)

Unsafe version of coverageReductionMode.