VkCoarseSampleOrderCustomNV (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCoarseSampleOrderCustomNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters controlling shading rate image usage.
Description

When using a custom sample ordering, element i in pSampleLocations specifies a specific pixel and per-pixel coverage sample number that corresponds to the coverage sample numbered i in the multi-pixel fragment.

Valid Usage
- shadingRate must be a shading rate that generates fragments with more than one pixel.
- sampleCount must correspond to a sample count enumerated in VkSampleCountFlags whose corresponding bit is set in VkPhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts.
- sampleLocationCount must be equal to the product of sampleCount, the fragment width for shadingRate, and the fragment height for shadingRate.
- sampleLocationCount must be less than or equal to the value of VkPhysicalDeviceShadingRateImagePropertiesNV::shadingRateMaxCoarseSamples.
- The array pSampleLocations must contain exactly one entry for every combination of valid values for pixelX, pixelY, and sample in the structure VkCoarseSampleOrderCustomNV.
Valid Usage (Implicit)
- shadingRate must be a valid VkShadingRatePaletteEntryNV value
- pSampleLocations must be a valid pointer to an array of sampleLocationCount VkCoarseSampleLocationNV structures
- sampleLocationCount must be greater than 0
See Also

VkCoarseSampleLocationNV, VkPipelineViewportCoarseSampleOrderStateCreateInfoNV, CmdSetCoarseSampleOrderNV

Member documentation
- shadingRate – a shading rate palette entry that identifies the fragment width and height for the combination of fragment area and per-pixel coverage sample count to control.
- sampleCount – identifies the per-pixel coverage sample count for the combination of fragment area and coverage sample count to control.
- sampleLocationCount – specifies the number of sample locations in the custom ordering.
- pSampleLocations – a pointer to an array of VkCoarseSampleOrderCustomNV structures specifying the location of each sample in the custom ordering.
Layout
```
 struct VkCoarseSampleOrderCustomNV {
     VkShadingRatePaletteEntryNV shadingRate;
     uint32_t sampleCount;
     uint32_t sampleLocationCount;
     VkCoarseSampleLocationNV const * pSampleLocations;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkCoarseSampleOrderCustomNV.Buffer
An array of VkCoarseSampleOrderCustomNV 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`	`VkCoarseSampleOrderCustomNV.Buffer` An array of `VkCoarseSampleOrderCustomNV` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PSAMPLELOCATIONS` The struct member offsets.
`static int`	`SAMPLECOUNT` The struct member offsets.
`static int`	`SAMPLELOCATIONCOUNT` The struct member offsets.
`static int`	`SHADINGRATE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkCoarseSampleOrderCustomNV(java.nio.ByteBuffer container)` Creates a `VkCoarseSampleOrderCustomNV` 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 VkCoarseSampleOrderCustomNV`	`calloc()` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memCalloc`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`calloc(int capacity)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memCalloc`.
`static VkCoarseSampleOrderCustomNV`	`callocStack()` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleOrderCustomNV.Buffer`	`callocStack(int capacity)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleOrderCustomNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleOrderCustomNV`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleOrderCustomNV`	`create()` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `BufferUtils`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`create(int capacity)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `BufferUtils`.
`static VkCoarseSampleOrderCustomNV`	`create(long address)` Returns a new `VkCoarseSampleOrderCustomNV` instance for the specified memory address.
`static VkCoarseSampleOrderCustomNV.Buffer`	`create(long address, int capacity)` Create a `VkCoarseSampleOrderCustomNV.Buffer` instance at the specified memory.
`static VkCoarseSampleOrderCustomNV`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCoarseSampleOrderCustomNV`	`malloc()` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memAlloc`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`malloc(int capacity)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memAlloc`.
`static VkCoarseSampleOrderCustomNV`	`mallocStack()` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the thread-local `MemoryStack`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`mallocStack(int capacity)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCoarseSampleOrderCustomNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCoarseSampleOrderCustomNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the specified `MemoryStack`.
`static VkCoarseSampleLocationNV.Buffer`	`npSampleLocations(long struct)` Unsafe version of `pSampleLocations()`.
`static void`	`npSampleLocations(long struct, VkCoarseSampleLocationNV.Buffer value)` Unsafe version of `pSampleLocations`.
`static int`	`nsampleCount(long struct)` Unsafe version of `sampleCount()`.
`static void`	`nsampleCount(long struct, int value)` Unsafe version of `sampleCount`.
`static int`	`nsampleLocationCount(long struct)` Unsafe version of `sampleLocationCount()`.
`static void`	`nsampleLocationCount(long struct, int value)` Sets the specified value to the `sampleLocationCount` field of the specified `struct`.
`static int`	`nshadingRate(long struct)` Unsafe version of `shadingRate()`.
`static void`	`nshadingRate(long struct, int value)` Unsafe version of `shadingRate`.
`VkCoarseSampleLocationNV.Buffer`	`pSampleLocations()` Returns a `VkCoarseSampleLocationNV.Buffer` view of the struct array pointed to by the `pSampleLocations` field.
`VkCoarseSampleOrderCustomNV`	`pSampleLocations(VkCoarseSampleLocationNV.Buffer value)` Sets the address of the specified `VkCoarseSampleLocationNV.Buffer` to the `pSampleLocations` field.
`int`	`sampleCount()` Returns the value of the `sampleCount` field.
`VkCoarseSampleOrderCustomNV`	`sampleCount(int value)` Sets the specified value to the `sampleCount` field.
`int`	`sampleLocationCount()` Returns the value of the `sampleLocationCount` field.
`VkCoarseSampleOrderCustomNV`	`set(int shadingRate, int sampleCount, VkCoarseSampleLocationNV.Buffer pSampleLocations)` Initializes this struct with the specified values.
`VkCoarseSampleOrderCustomNV`	`set(VkCoarseSampleOrderCustomNV src)` Copies the specified struct data to this struct.
`int`	`shadingRate()` Returns the value of the `shadingRate` field.
`VkCoarseSampleOrderCustomNV`	`shadingRate(int value)` Sets the specified value to the `shadingRate` field.
`int`	`sizeof()`
`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.
  - SHADINGRATE
```
public static final int SHADINGRATE
```
    The struct member offsets.
  - SAMPLECOUNT
```
public static final int SAMPLECOUNT
```
    The struct member offsets.
  - SAMPLELOCATIONCOUNT
```
public static final int SAMPLELOCATIONCOUNT
```
    The struct member offsets.
  - PSAMPLELOCATIONS
```
public static final int PSAMPLELOCATIONS
```
    The struct member offsets.
- Constructor Detail
  - VkCoarseSampleOrderCustomNV
```
public VkCoarseSampleOrderCustomNV(java.nio.ByteBuffer container)
```
    Creates a VkCoarseSampleOrderCustomNV 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
  - shadingRate
```
public int shadingRate()
```
    Returns the value of the shadingRate field.
  - sampleCount
```
public int sampleCount()
```
    Returns the value of the sampleCount field.
  - sampleLocationCount
```
public int sampleLocationCount()
```
    Returns the value of the sampleLocationCount field.
  - pSampleLocations
```
public VkCoarseSampleLocationNV.Buffer pSampleLocations()
```
    Returns a VkCoarseSampleLocationNV.Buffer view of the struct array pointed to by the pSampleLocations field.
  - shadingRate
```
public VkCoarseSampleOrderCustomNV shadingRate(int value)
```
    Sets the specified value to the shadingRate field.
  - sampleCount
```
public VkCoarseSampleOrderCustomNV sampleCount(int value)
```
    Sets the specified value to the sampleCount field.
  - pSampleLocations
```
public VkCoarseSampleOrderCustomNV pSampleLocations(VkCoarseSampleLocationNV.Buffer value)
```
    Sets the address of the specified VkCoarseSampleLocationNV.Buffer to the pSampleLocations field.
  - set
```
public VkCoarseSampleOrderCustomNV set(int shadingRate,
                                       int sampleCount,
                                       VkCoarseSampleLocationNV.Buffer pSampleLocations)
```
    Initializes this struct with the specified values.
  - set
```
public VkCoarseSampleOrderCustomNV set(VkCoarseSampleOrderCustomNV src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkCoarseSampleOrderCustomNV malloc()
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCoarseSampleOrderCustomNV calloc()
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCoarseSampleOrderCustomNV create()
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated with BufferUtils.
  - create
```
public static VkCoarseSampleOrderCustomNV create(long address)
```
    Returns a new VkCoarseSampleOrderCustomNV instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCoarseSampleOrderCustomNV createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCoarseSampleOrderCustomNV.Buffer malloc(int capacity)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCoarseSampleOrderCustomNV.Buffer calloc(int capacity)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCoarseSampleOrderCustomNV.Buffer create(int capacity)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCoarseSampleOrderCustomNV.Buffer create(long address,
                                                        int capacity)
```
    Create a VkCoarseSampleOrderCustomNV.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCoarseSampleOrderCustomNV.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkCoarseSampleOrderCustomNV mallocStack()
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCoarseSampleOrderCustomNV callocStack()
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCoarseSampleOrderCustomNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCoarseSampleOrderCustomNV callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkCoarseSampleOrderCustomNV.Buffer mallocStack(int capacity)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCoarseSampleOrderCustomNV.Buffer callocStack(int capacity)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCoarseSampleOrderCustomNV.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCoarseSampleOrderCustomNV.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleOrderCustomNV.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
  - nshadingRate
```
public static int nshadingRate(long struct)
```
    Unsafe version of shadingRate().
  - nsampleCount
```
public static int nsampleCount(long struct)
```
    Unsafe version of sampleCount().
  - nsampleLocationCount
```
public static int nsampleLocationCount(long struct)
```
    Unsafe version of sampleLocationCount().
  - npSampleLocations
```
public static VkCoarseSampleLocationNV.Buffer npSampleLocations(long struct)
```
    Unsafe version of pSampleLocations().
  - nshadingRate
```
public static void nshadingRate(long struct,
                                int value)
```
    Unsafe version of shadingRate.
  - nsampleCount
```
public static void nsampleCount(long struct,
                                int value)
```
    Unsafe version of sampleCount.
  - nsampleLocationCount
```
public static void nsampleLocationCount(long struct,
                                        int value)
```
    Sets the specified value to the sampleLocationCount field of the specified struct.
  - npSampleLocations
```
public static void npSampleLocations(long struct,
                                     VkCoarseSampleLocationNV.Buffer value)
```
    Unsafe version of pSampleLocations.
  - 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 VkCoarseSampleOrderCustomNV

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

SHADINGRATE

SAMPLECOUNT

SAMPLELOCATIONCOUNT

PSAMPLELOCATIONS

Constructor Detail

VkCoarseSampleOrderCustomNV

Method Detail

sizeof

shadingRate

sampleCount

sampleLocationCount

pSampleLocations

shadingRate

sampleCount

pSampleLocations

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nshadingRate

nsampleCount

nsampleLocationCount

npSampleLocations

nshadingRate

nsampleCount

nsampleLocationCount

npSampleLocations

validate

validate