VkShadingRatePaletteNV (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkShadingRatePaletteNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a single shading rate palette.
Valid Usage
- shadingRatePaletteEntryCount must be between 1 and VkPhysicalDeviceShadingRateImagePropertiesNV::shadingRatePaletteSize, inclusive
Valid Usage (Implicit)
- pShadingRatePaletteEntries must be a valid pointer to an array of shadingRatePaletteEntryCount valid VkShadingRatePaletteEntryNV values
- shadingRatePaletteEntryCount must be greater than 0
See Also

VkPipelineViewportShadingRateImageStateCreateInfoNV, CmdSetViewportShadingRatePaletteNV

Member documentation
- shadingRatePaletteEntryCount – specifies the number of entries in the shading rate image palette.
- pShadingRatePaletteEntries – a pointer to an array of VkShadingRatePaletteEntryNV enums defining the shading rate for each palette entry.
Layout
```
 struct VkShadingRatePaletteNV {
     uint32_t shadingRatePaletteEntryCount;
     VkShadingRatePaletteEntryNV const * pShadingRatePaletteEntries;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PSHADINGRATEPALETTEENTRIES` The struct member offsets.
`static int`	`SHADINGRATEPALETTEENTRYCOUNT` 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
`VkShadingRatePaletteNV(java.nio.ByteBuffer container)` Creates a `VkShadingRatePaletteNV` 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 VkShadingRatePaletteNV`	`calloc()` Returns a new `VkShadingRatePaletteNV` instance allocated with `memCalloc`.
`static VkShadingRatePaletteNV.Buffer`	`calloc(int capacity)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated with `memCalloc`.
`static VkShadingRatePaletteNV`	`callocStack()` Returns a new `VkShadingRatePaletteNV` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkShadingRatePaletteNV.Buffer`	`callocStack(int capacity)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkShadingRatePaletteNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkShadingRatePaletteNV`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkShadingRatePaletteNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkShadingRatePaletteNV`	`create()` Returns a new `VkShadingRatePaletteNV` instance allocated with `BufferUtils`.
`static VkShadingRatePaletteNV.Buffer`	`create(int capacity)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated with `BufferUtils`.
`static VkShadingRatePaletteNV`	`create(long address)` Returns a new `VkShadingRatePaletteNV` instance for the specified memory address.
`static VkShadingRatePaletteNV.Buffer`	`create(long address, int capacity)` Create a `VkShadingRatePaletteNV.Buffer` instance at the specified memory.
`static VkShadingRatePaletteNV`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkShadingRatePaletteNV.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkShadingRatePaletteNV`	`malloc()` Returns a new `VkShadingRatePaletteNV` instance allocated with `memAlloc`.
`static VkShadingRatePaletteNV.Buffer`	`malloc(int capacity)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated with `memAlloc`.
`static VkShadingRatePaletteNV`	`mallocStack()` Returns a new `VkShadingRatePaletteNV` instance allocated on the thread-local `MemoryStack`.
`static VkShadingRatePaletteNV.Buffer`	`mallocStack(int capacity)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkShadingRatePaletteNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkShadingRatePaletteNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkShadingRatePaletteNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkShadingRatePaletteNV` instance allocated on the specified `MemoryStack`.
`static java.nio.IntBuffer`	`npShadingRatePaletteEntries(long struct)` Unsafe version of `pShadingRatePaletteEntries`.
`static void`	`npShadingRatePaletteEntries(long struct, java.nio.IntBuffer value)` Unsafe version of `pShadingRatePaletteEntries`.
`static int`	`nshadingRatePaletteEntryCount(long struct)` Unsafe version of `shadingRatePaletteEntryCount()`.
`static void`	`nshadingRatePaletteEntryCount(long struct, int value)` Sets the specified value to the `shadingRatePaletteEntryCount` field of the specified `struct`.
`java.nio.IntBuffer`	`pShadingRatePaletteEntries()` Returns a `IntBuffer` view of the data pointed to by the `pShadingRatePaletteEntries` field.
`VkShadingRatePaletteNV`	`pShadingRatePaletteEntries(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `pShadingRatePaletteEntries` field.
`VkShadingRatePaletteNV`	`set(VkShadingRatePaletteNV src)` Copies the specified struct data to this struct.
`int`	`shadingRatePaletteEntryCount()` Returns the value of the `shadingRatePaletteEntryCount` 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.
  - SHADINGRATEPALETTEENTRYCOUNT
```
public static final int SHADINGRATEPALETTEENTRYCOUNT
```
    The struct member offsets.
  - PSHADINGRATEPALETTEENTRIES
```
public static final int PSHADINGRATEPALETTEENTRIES
```
    The struct member offsets.
- Constructor Detail
  - VkShadingRatePaletteNV
```
public VkShadingRatePaletteNV(java.nio.ByteBuffer container)
```
    Creates a VkShadingRatePaletteNV 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
  - shadingRatePaletteEntryCount
```
public int shadingRatePaletteEntryCount()
```
    Returns the value of the shadingRatePaletteEntryCount field.
  - pShadingRatePaletteEntries
```
public java.nio.IntBuffer pShadingRatePaletteEntries()
```
    Returns a IntBuffer view of the data pointed to by the pShadingRatePaletteEntries field.
  - pShadingRatePaletteEntries
```
public VkShadingRatePaletteNV pShadingRatePaletteEntries(java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pShadingRatePaletteEntries field.
  - set
```
public VkShadingRatePaletteNV set(VkShadingRatePaletteNV src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkShadingRatePaletteNV malloc()
```
    Returns a new VkShadingRatePaletteNV instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkShadingRatePaletteNV calloc()
```
    Returns a new VkShadingRatePaletteNV instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkShadingRatePaletteNV create()
```
    Returns a new VkShadingRatePaletteNV instance allocated with BufferUtils.
  - create
```
public static VkShadingRatePaletteNV create(long address)
```
    Returns a new VkShadingRatePaletteNV instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkShadingRatePaletteNV createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkShadingRatePaletteNV.Buffer malloc(int capacity)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkShadingRatePaletteNV.Buffer calloc(int capacity)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkShadingRatePaletteNV.Buffer create(int capacity)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkShadingRatePaletteNV.Buffer create(long address,
                                                   int capacity)
```
    Create a VkShadingRatePaletteNV.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkShadingRatePaletteNV.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkShadingRatePaletteNV mallocStack()
```
    Returns a new VkShadingRatePaletteNV instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkShadingRatePaletteNV callocStack()
```
    Returns a new VkShadingRatePaletteNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkShadingRatePaletteNV mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkShadingRatePaletteNV callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkShadingRatePaletteNV.Buffer mallocStack(int capacity)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkShadingRatePaletteNV.Buffer callocStack(int capacity)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkShadingRatePaletteNV.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkShadingRatePaletteNV.Buffer callocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkShadingRatePaletteNV.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
  - nshadingRatePaletteEntryCount
```
public static int nshadingRatePaletteEntryCount(long struct)
```
    Unsafe version of shadingRatePaletteEntryCount().
  - npShadingRatePaletteEntries
```
public static java.nio.IntBuffer npShadingRatePaletteEntries(long struct)
```
    Unsafe version of pShadingRatePaletteEntries.
  - nshadingRatePaletteEntryCount
```
public static void nshadingRatePaletteEntryCount(long struct,
                                                 int value)
```
    Sets the specified value to the shadingRatePaletteEntryCount field of the specified struct.
  - npShadingRatePaletteEntries
```
public static void npShadingRatePaletteEntries(long struct,
                                               java.nio.IntBuffer value)
```
    Unsafe version of pShadingRatePaletteEntries.
  - 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 VkShadingRatePaletteNV

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

SHADINGRATEPALETTEENTRYCOUNT

PSHADINGRATEPALETTEENTRIES

Constructor Detail

VkShadingRatePaletteNV

Method Detail

sizeof

shadingRatePaletteEntryCount

pShadingRatePaletteEntries

pShadingRatePaletteEntries

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nshadingRatePaletteEntryCount

npShadingRatePaletteEntries

nshadingRatePaletteEntryCount

npShadingRatePaletteEntries

validate

validate