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

All Implemented Interfaces:

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

If this structure is not present, shadingRateImageEnable is considered to be FALSE, and the shading rate image and palettes are not used.

Valid Usage
- If the multiple viewports feature is not enabled, viewportCount must be 0 or 1
- viewportCount must be less than or equal to VkPhysicalDeviceLimits::maxViewports
- If shadingRateImageEnable is TRUE, viewportCount must be greater or equal to the viewportCount member of VkPipelineViewportStateCreateInfo
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV
See Also

VkShadingRatePaletteNV

Layout
```
 struct VkPipelineViewportShadingRateImageStateCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkBool32 shadingRateImageEnable();
     uint32_t viewportCount();
     VkShadingRatePaletteNV const * pShadingRatePalettes();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	An array of `VkPipelineViewportShadingRateImageStateCreateInfoNV` 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`	`PNEXT PSHADINGRATEPALETTES SHADINGRATEIMAGEENABLE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE VIEWPORTCOUNT`	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
`VkPipelineViewportShadingRateImageStateCreateInfoNV(java.nio.ByteBuffer container)`	Creates a `VkPipelineViewportShadingRateImageStateCreateInfoNV` 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 VkPipelineViewportShadingRateImageStateCreateInfoNV`	`calloc()`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance allocated with `memCalloc`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance allocated with `memCalloc`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`callocStack()`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`create()`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance allocated with `BufferUtils`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`create(int capacity)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`create(long address)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance for the specified memory address.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance at the specified memory.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`malloc()`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance allocated with `memAlloc`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance allocated with `memAlloc`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineViewportShadingRateImageStateCreateInfoNV` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`mallocStack()`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineViewportShadingRateImageStateCreateInfoNV`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkShadingRatePaletteNV.Buffer`	`npShadingRatePalettes(long struct)`	Unsafe version of `pShadingRatePalettes()`.
`static void`	`npShadingRatePalettes(long struct, VkShadingRatePaletteNV.Buffer value)`	Unsafe version of `pShadingRatePalettes`.
`static int`	`nshadingRateImageEnable(long struct)`	Unsafe version of `shadingRateImageEnable()`.
`static void`	`nshadingRateImageEnable(long struct, int value)`	Unsafe version of `shadingRateImageEnable`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`nviewportCount(long struct)`	Unsafe version of `viewportCount()`.
`static void`	`nviewportCount(long struct, int value)`	Sets the specified value to the `viewportCount` field of the specified `struct`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkShadingRatePaletteNV.Buffer`	`pShadingRatePalettes()`	a pointer to an array of `VkShadingRatePaletteNV` structures defining the palette for each viewport.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`pShadingRatePalettes(VkShadingRatePaletteNV.Buffer value)`	Sets the address of the specified `VkShadingRatePaletteNV.Buffer` to the `pShadingRatePalettes()` field.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`set(int sType, long pNext, boolean shadingRateImageEnable, int viewportCount, VkShadingRatePaletteNV.Buffer pShadingRatePalettes)`	Initializes this struct with the specified values.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`set(VkPipelineViewportShadingRateImageStateCreateInfoNV src)`	Copies the specified struct data to this struct.
`boolean`	`shadingRateImageEnable()`	specifies whether shading rate image and palettes are used during rasterization.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`shadingRateImageEnable(boolean value)`	Sets the specified value to the `shadingRateImageEnable()` field.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`sType$Default()`	Sets the `STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV` value to the `sType()` field.
`int`	`viewportCount()`	specifies the number of per-viewport palettes used to translate values stored in shading rate images.
`VkPipelineViewportShadingRateImageStateCreateInfoNV`	`viewportCount(int value)`	Sets the specified value to the `viewportCount()` field.

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, SHADINGRATEIMAGEENABLE, VIEWPORTCOUNT, PSHADINGRATEPALETTES
  
  The struct member offsets.

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

shadingRateImageEnable
```
public boolean shadingRateImageEnable()
```
specifies whether shading rate image and palettes are used during rasterization.

viewportCount
```
public int viewportCount()
```
specifies the number of per-viewport palettes used to translate values stored in shading rate images.

pShadingRatePalettes
```
@Nullable
public VkShadingRatePaletteNV.Buffer pShadingRatePalettes()
```
a pointer to an array of VkShadingRatePaletteNV structures defining the palette for each viewport. If the shading rate palette state is dynamic, this member is ignored.

sType

public VkPipelineViewportShadingRateImageStateCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkPipelineViewportShadingRateImageStateCreateInfoNV sType$Default()
```
Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV value to the sType() field.

pNext

public VkPipelineViewportShadingRateImageStateCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

shadingRateImageEnable

public VkPipelineViewportShadingRateImageStateCreateInfoNV shadingRateImageEnable(boolean value)

Sets the specified value to the shadingRateImageEnable() field.

viewportCount

public VkPipelineViewportShadingRateImageStateCreateInfoNV viewportCount(int value)

Sets the specified value to the viewportCount() field.

pShadingRatePalettes

public VkPipelineViewportShadingRateImageStateCreateInfoNV pShadingRatePalettes(@Nullable
                                                                                VkShadingRatePaletteNV.Buffer value)

Sets the address of the specified VkShadingRatePaletteNV.Buffer to the pShadingRatePalettes() field.

set

public VkPipelineViewportShadingRateImageStateCreateInfoNV set(int sType,
                                                               long pNext,
                                                               boolean shadingRateImageEnable,
                                                               int viewportCount,
                                                               @Nullable
                                                               VkShadingRatePaletteNV.Buffer pShadingRatePalettes)

Initializes this struct with the specified values.

set

public VkPipelineViewportShadingRateImageStateCreateInfoNV set(VkPipelineViewportShadingRateImageStateCreateInfoNV src)

Copies the specified struct data to this struct.

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

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

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

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

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

createSafe

@Nullable
public static VkPipelineViewportShadingRateImageStateCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Parameters:

capacity - the buffer capacity

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

Parameters:

capacity - the buffer capacity

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

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance at the specified memory.

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

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineViewportShadingRateImageStateCreateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineViewportShadingRateImageStateCreateInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Parameters:

stack - the stack from which to allocate

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

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

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

nshadingRateImageEnable
```
public static int nshadingRateImageEnable(long struct)
```
Unsafe version of shadingRateImageEnable().

nviewportCount

public static int nviewportCount(long struct)

Unsafe version of viewportCount().

npShadingRatePalettes

@Nullable
public static VkShadingRatePaletteNV.Buffer npShadingRatePalettes(long struct)

Unsafe version of pShadingRatePalettes().

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.

nshadingRateImageEnable

public static void nshadingRateImageEnable(long struct,
                                           int value)

Unsafe version of shadingRateImageEnable.

nviewportCount

public static void nviewportCount(long struct,
                                  int value)

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

npShadingRatePalettes

public static void npShadingRatePalettes(long struct,
                                         @Nullable
                                         VkShadingRatePaletteNV.Buffer value)

Unsafe version of pShadingRatePalettes.

Class VkPipelineViewportShadingRateImageStateCreateInfoNV

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, SHADINGRATEIMAGEENABLE, VIEWPORTCOUNT, PSHADINGRATEPALETTES

Constructor Detail

VkPipelineViewportShadingRateImageStateCreateInfoNV

Method Detail

sizeof

sType

pNext

shadingRateImageEnable

viewportCount

pShadingRatePalettes

sType

sType$Default

pNext

shadingRateImageEnable

viewportCount

pShadingRatePalettes

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

nshadingRateImageEnable

nviewportCount

npShadingRatePalettes

nsType

npNext

nshadingRateImageEnable

nviewportCount

npShadingRatePalettes