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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters controlling sample order in coarse fragments.
Description

If this structure is not present, sampleOrderType is considered to be COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If sampleOrderType is COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated in pCustomSampleOrders will be identical to that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If the pipeline was created with DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV, the contents of this structure (if present) are ignored, and the coverage sample order is instead specified by CmdSetCoarseSampleOrderNV.

Valid Usage
- If sampleOrderType is not COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, customSamplerOrderCount must be 0
- The array pCustomSampleOrders must not contain two structures with matching values for both the shadingRate and sampleCount members
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV
- sampleOrderType must be a valid VkCoarseSampleOrderTypeNV value
- If customSampleOrderCount is not 0, pCustomSampleOrders must be a valid pointer to an array of customSampleOrderCount valid VkCoarseSampleOrderCustomNV structures
See Also

VkCoarseSampleOrderCustomNV

Layout
```
 struct VkPipelineViewportCoarseSampleOrderStateCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkCoarseSampleOrderTypeNV sampleOrderType();
     uint32_t customSampleOrderCount();
     VkCoarseSampleOrderCustomNV const * pCustomSampleOrders();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	An array of `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` 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`	`CUSTOMSAMPLEORDERCOUNT PCUSTOMSAMPLEORDERS PNEXT SAMPLEORDERTYPE`	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
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV(java.nio.ByteBuffer container)`	Creates a `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`calloc()`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated with `memCalloc`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated with `memCalloc`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`callocStack()`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`create()`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated with `BufferUtils`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`create(int capacity)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`create(long address)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance for the specified memory address.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance at the specified memory.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`customSampleOrderCount()`	specifies the number of custom sample orderings to use when ordering coverage samples.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`malloc()`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated with `memAlloc`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated with `memAlloc`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`mallocStack()`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static int`	`ncustomSampleOrderCount(long struct)`	Unsafe version of `customSampleOrderCount()`.
`static void`	`ncustomSampleOrderCount(long struct, int value)`	Sets the specified value to the `customSampleOrderCount` field of the specified `struct`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`npCustomSampleOrders(long struct)`	Unsafe version of `pCustomSampleOrders()`.
`static void`	`npCustomSampleOrders(long struct, VkCoarseSampleOrderCustomNV.Buffer value)`	Unsafe version of `pCustomSampleOrders`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsampleOrderType(long struct)`	Unsafe version of `sampleOrderType()`.
`static void`	`nsampleOrderType(long struct, int value)`	Unsafe version of `sampleOrderType`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`VkCoarseSampleOrderCustomNV.Buffer`	`pCustomSampleOrders()`	a pointer to an array of `customSampleOrderCount` `VkCoarseSampleOrderCustomNV` structures, each structure specifying the coverage sample order for a single combination of fragment area and coverage sample count.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`pCustomSampleOrders(VkCoarseSampleOrderCustomNV.Buffer value)`	Sets the address of the specified `VkCoarseSampleOrderCustomNV.Buffer` to the `pCustomSampleOrders()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`int`	`sampleOrderType()`	specifies the mechanism used to order coverage samples in fragments larger than one pixel.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`sampleOrderType(int value)`	Sets the specified value to the `sampleOrderType()` field.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`set(int sType, long pNext, int sampleOrderType, VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders)`	Initializes this struct with the specified values.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`set(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`sType$Default()`	Sets the `STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.

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, SAMPLEORDERTYPE, CUSTOMSAMPLEORDERCOUNT, PCUSTOMSAMPLEORDERS
  
  The struct member offsets.

Constructor Detail
- VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
```
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV(java.nio.ByteBuffer container)
```
  Creates a VkPipelineViewportCoarseSampleOrderStateCreateInfoNV 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.

sampleOrderType
```
public int sampleOrderType()
```
specifies the mechanism used to order coverage samples in fragments larger than one pixel.

customSampleOrderCount
```
public int customSampleOrderCount()
```
specifies the number of custom sample orderings to use when ordering coverage samples.

pCustomSampleOrders
```
@Nullable
public VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders()
```
a pointer to an array of customSampleOrderCount VkCoarseSampleOrderCustomNV structures, each structure specifying the coverage sample order for a single combination of fragment area and coverage sample count.

sType

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sType$Default()
```
Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV value to the sType() field.

pNext

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

sampleOrderType

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sampleOrderType(int value)

Sets the specified value to the sampleOrderType() field.

pCustomSampleOrders

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV pCustomSampleOrders(@Nullable
                                                                                VkCoarseSampleOrderCustomNV.Buffer value)

Sets the address of the specified VkCoarseSampleOrderCustomNV.Buffer to the pCustomSampleOrders() field.

set

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV set(int sType,
                                                                long pNext,
                                                                int sampleOrderType,
                                                                @Nullable
                                                                VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders)

Initializes this struct with the specified values.

set

public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV set(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV malloc()
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV calloc()
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV create()
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated with BufferUtils.

create
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV create(long address)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer malloc(int capacity)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer calloc(int capacity)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer create(int capacity)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.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 VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.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 VkPipelineViewportCoarseSampleOrderStateCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer calloc(int capacity,
                                                                                 org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.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().

nsampleOrderType

public static int nsampleOrderType(long struct)

Unsafe version of sampleOrderType().

ncustomSampleOrderCount
```
public static int ncustomSampleOrderCount(long struct)
```
Unsafe version of customSampleOrderCount().

npCustomSampleOrders

@Nullable
public static VkCoarseSampleOrderCustomNV.Buffer npCustomSampleOrders(long struct)

Unsafe version of pCustomSampleOrders().

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.

nsampleOrderType

public static void nsampleOrderType(long struct,
                                    int value)

Unsafe version of sampleOrderType.

ncustomSampleOrderCount

public static void ncustomSampleOrderCount(long struct,
                                           int value)

Sets the specified value to the customSampleOrderCount field of the specified struct.

npCustomSampleOrders

public static void npCustomSampleOrders(long struct,
                                        @Nullable
                                        VkCoarseSampleOrderCustomNV.Buffer value)

Unsafe version of pCustomSampleOrders.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

Class VkPipelineViewportCoarseSampleOrderStateCreateInfoNV

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

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, SAMPLEORDERTYPE, CUSTOMSAMPLEORDERCOUNT, PCUSTOMSAMPLEORDERS

Constructor Detail

VkPipelineViewportCoarseSampleOrderStateCreateInfoNV

Method Detail

sizeof

sType

pNext

sampleOrderType

customSampleOrderCount

pCustomSampleOrders

sType

sType$Default

pNext

sampleOrderType

pCustomSampleOrders

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nsampleOrderType

ncustomSampleOrderCount

npCustomSampleOrders

nsType

npNext

nsampleOrderType

ncustomSampleOrderCount

npCustomSampleOrders

validate