VkCoarseSampleLocationNV (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCoarseSampleLocationNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters controlling shading rate image usage.
Valid Usage
- pixelX must be less than the width (in pixels) of the fragment.
- pixelY must be less than the height (in pixels) of the fragment.
- sample must be less than the number of coverage samples in each pixel belonging to the fragment.
See Also

VkCoarseSampleOrderCustomNV

Member documentation
- pixelX – added to the x coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.
- pixelY – added to the y coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.
- sample – the number of the coverage sample in the pixel identified by pixelX and pixelY.
Layout
```
 struct VkCoarseSampleLocationNV {
     uint32_t pixelX;
     uint32_t pixelY;
     uint32_t sample;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PIXELX` The struct member offsets.
`static int`	`PIXELY` The struct member offsets.
`static int`	`SAMPLE` 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
`VkCoarseSampleLocationNV(java.nio.ByteBuffer container)` Creates a `VkCoarseSampleLocationNV` 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 VkCoarseSampleLocationNV`	`calloc()` Returns a new `VkCoarseSampleLocationNV` instance allocated with `memCalloc`.
`static VkCoarseSampleLocationNV.Buffer`	`calloc(int capacity)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated with `memCalloc`.
`static VkCoarseSampleLocationNV`	`callocStack()` Returns a new `VkCoarseSampleLocationNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleLocationNV.Buffer`	`callocStack(int capacity)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleLocationNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleLocationNV`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleLocationNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCoarseSampleLocationNV`	`create()` Returns a new `VkCoarseSampleLocationNV` instance allocated with `BufferUtils`.
`static VkCoarseSampleLocationNV.Buffer`	`create(int capacity)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated with `BufferUtils`.
`static VkCoarseSampleLocationNV`	`create(long address)` Returns a new `VkCoarseSampleLocationNV` instance for the specified memory address.
`static VkCoarseSampleLocationNV.Buffer`	`create(long address, int capacity)` Create a `VkCoarseSampleLocationNV.Buffer` instance at the specified memory.
`static VkCoarseSampleLocationNV`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCoarseSampleLocationNV.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCoarseSampleLocationNV`	`malloc()` Returns a new `VkCoarseSampleLocationNV` instance allocated with `memAlloc`.
`static VkCoarseSampleLocationNV.Buffer`	`malloc(int capacity)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated with `memAlloc`.
`static VkCoarseSampleLocationNV`	`mallocStack()` Returns a new `VkCoarseSampleLocationNV` instance allocated on the thread-local `MemoryStack`.
`static VkCoarseSampleLocationNV.Buffer`	`mallocStack(int capacity)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCoarseSampleLocationNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleLocationNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCoarseSampleLocationNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCoarseSampleLocationNV` instance allocated on the specified `MemoryStack`.
`static int`	`npixelX(long struct)` Unsafe version of `pixelX()`.
`static void`	`npixelX(long struct, int value)` Unsafe version of `pixelX`.
`static int`	`npixelY(long struct)` Unsafe version of `pixelY()`.
`static void`	`npixelY(long struct, int value)` Unsafe version of `pixelY`.
`static int`	`nsample(long struct)` Unsafe version of `sample()`.
`static void`	`nsample(long struct, int value)` Unsafe version of `sample`.
`int`	`pixelX()` Returns the value of the `pixelX` field.
`VkCoarseSampleLocationNV`	`pixelX(int value)` Sets the specified value to the `pixelX` field.
`int`	`pixelY()` Returns the value of the `pixelY` field.
`VkCoarseSampleLocationNV`	`pixelY(int value)` Sets the specified value to the `pixelY` field.
`int`	`sample()` Returns the value of the `sample` field.
`VkCoarseSampleLocationNV`	`sample(int value)` Sets the specified value to the `sample` field.
`VkCoarseSampleLocationNV`	`set(int pixelX, int pixelY, int sample)` Initializes this struct with the specified values.
`VkCoarseSampleLocationNV`	`set(VkCoarseSampleLocationNV src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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.
  - PIXELX
```
public static final int PIXELX
```
    The struct member offsets.
  - PIXELY
```
public static final int PIXELY
```
    The struct member offsets.
  - SAMPLE
```
public static final int SAMPLE
```
    The struct member offsets.
- Constructor Detail
  - VkCoarseSampleLocationNV
```
public VkCoarseSampleLocationNV(java.nio.ByteBuffer container)
```
    Creates a VkCoarseSampleLocationNV 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
  - pixelX
```
public int pixelX()
```
    Returns the value of the pixelX field.
  - pixelY
```
public int pixelY()
```
    Returns the value of the pixelY field.
  - sample
```
public int sample()
```
    Returns the value of the sample field.
  - pixelX
```
public VkCoarseSampleLocationNV pixelX(int value)
```
    Sets the specified value to the pixelX field.
  - pixelY
```
public VkCoarseSampleLocationNV pixelY(int value)
```
    Sets the specified value to the pixelY field.
  - sample
```
public VkCoarseSampleLocationNV sample(int value)
```
    Sets the specified value to the sample field.
  - set
```
public VkCoarseSampleLocationNV set(int pixelX,
                                    int pixelY,
                                    int sample)
```
    Initializes this struct with the specified values.
  - set
```
public VkCoarseSampleLocationNV set(VkCoarseSampleLocationNV src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkCoarseSampleLocationNV malloc()
```
    Returns a new VkCoarseSampleLocationNV instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCoarseSampleLocationNV calloc()
```
    Returns a new VkCoarseSampleLocationNV instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCoarseSampleLocationNV create()
```
    Returns a new VkCoarseSampleLocationNV instance allocated with BufferUtils.
  - create
```
public static VkCoarseSampleLocationNV create(long address)
```
    Returns a new VkCoarseSampleLocationNV instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCoarseSampleLocationNV createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCoarseSampleLocationNV.Buffer malloc(int capacity)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCoarseSampleLocationNV.Buffer calloc(int capacity)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCoarseSampleLocationNV.Buffer create(int capacity)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCoarseSampleLocationNV.Buffer create(long address,
                                                     int capacity)
```
    Create a VkCoarseSampleLocationNV.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCoarseSampleLocationNV.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkCoarseSampleLocationNV mallocStack()
```
    Returns a new VkCoarseSampleLocationNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCoarseSampleLocationNV callocStack()
```
    Returns a new VkCoarseSampleLocationNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCoarseSampleLocationNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCoarseSampleLocationNV callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkCoarseSampleLocationNV.Buffer mallocStack(int capacity)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCoarseSampleLocationNV.Buffer callocStack(int capacity)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCoarseSampleLocationNV.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleLocationNV.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCoarseSampleLocationNV.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCoarseSampleLocationNV.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
  - npixelX
```
public static int npixelX(long struct)
```
    Unsafe version of pixelX().
  - npixelY
```
public static int npixelY(long struct)
```
    Unsafe version of pixelY().
  - nsample
```
public static int nsample(long struct)
```
    Unsafe version of sample().
  - npixelX
```
public static void npixelX(long struct,
                           int value)
```
    Unsafe version of pixelX.
  - npixelY
```
public static void npixelY(long struct,
                           int value)
```
    Unsafe version of pixelY.
  - nsample
```
public static void nsample(long struct,
                           int value)
```
    Unsafe version of sample.

Class VkCoarseSampleLocationNV

Valid Usage

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

PIXELX

PIXELY

SAMPLE

Constructor Detail

VkCoarseSampleLocationNV

Method Detail

sizeof

pixelX

pixelY

sample

pixelX

pixelY

sample

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

npixelX

npixelY

nsample

npixelX

npixelY

nsample