VkPipelineViewportCoarseSampleOrderStateCreateInfoNV (LWJGL 3.2.4 SNAPSHOT

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

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- sampleOrderType – specifies the mechanism used to order coverage samples in fragments larger than one pixel.
- customSampleOrderCount – specifies the number of custom sample orderings to use when ordering coverage samples.
- pCustomSampleOrders – a pointer to an array of customSampleOrderCount VkCoarseSampleOrderCustomNV structures, each of which specifies the coverage sample order for a single combination of fragment area and coverage sample count.
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 and 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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CUSTOMSAMPLEORDERCOUNT` The struct member offsets.
`static int`	`PCUSTOMSAMPLEORDERS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`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 and 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
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns the value of the `customSampleOrderCount` field.
`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`	`mallocStack()` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportCoarseSampleOrderStateCreateInfoNV` instance allocated on the specified `MemoryStack`.
`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()` Returns a `VkCoarseSampleOrderCustomNV.Buffer` view of the struct array pointed to by the `pCustomSampleOrders` field.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`pCustomSampleOrders(VkCoarseSampleOrderCustomNV.Buffer value)` Sets the address of the specified `VkCoarseSampleOrderCustomNV.Buffer` to the `pCustomSampleOrders` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`sampleOrderType()` Returns the value of the `sampleOrderType` field.
`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()` Returns the value of the `sType` field.
`VkPipelineViewportCoarseSampleOrderStateCreateInfoNV`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - SAMPLEORDERTYPE
```
public static final int SAMPLEORDERTYPE
```
    The struct member offsets.
  - CUSTOMSAMPLEORDERCOUNT
```
public static final int CUSTOMSAMPLEORDERCOUNT
```
    The struct member offsets.
  - PCUSTOMSAMPLEORDERS
```
public static final int 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - sampleOrderType
```
public int sampleOrderType()
```
    Returns the value of the sampleOrderType field.
  - customSampleOrderCount
```
public int customSampleOrderCount()
```
    Returns the value of the customSampleOrderCount field.
  - pCustomSampleOrders
```
@Nullable
public VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders()
```
    Returns a VkCoarseSampleOrderCustomNV.Buffer view of the struct array pointed to by the pCustomSampleOrders field.
  - sType
```
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sType(int value)
```
    Sets the specified 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
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV mallocStack()
```
    Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV callocStack()
```
    Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV callocStack(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
  - mallocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer mallocStack(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
  - callocStack
```
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer callocStack(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
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkPipelineViewportCoarseSampleOrderStateCreateInfoNV

Description

Valid Usage

Valid Usage (Implicit)

See Also

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

SAMPLEORDERTYPE

CUSTOMSAMPLEORDERCOUNT

PCUSTOMSAMPLEORDERS

Constructor Detail

VkPipelineViewportCoarseSampleOrderStateCreateInfoNV

Method Detail

sizeof

sType

pNext

sampleOrderType

customSampleOrderCount

pCustomSampleOrders

sType

pNext

sampleOrderType

pCustomSampleOrders

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsampleOrderType

ncustomSampleOrderCount

npCustomSampleOrders

nsType

npNext

nsampleOrderType

ncustomSampleOrderCount

npCustomSampleOrders

validate

validate