org.lwjgl.vulkan

Class VkPipelineViewportShadingRateImageStateCreateInfoNV

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 equal to the viewportCount member of VkPipelineViewportStateCreateInfo
• If no element of the pDynamicStates member of pDynamicState is DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV, pShadingRatePalettes must be a valid pointer to an array of viewportCount VkShadingRatePaletteNV structures

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV
• If viewportCount is not 0, and pShadingRatePalettes is not NULL, pShadingRatePalettes must be a valid pointer to an array of viewportCount valid VkShadingRatePaletteNV structures

See Also

VkShadingRatePaletteNV

Member documentation

• sType – the type of this structure.
• pNext – NULL or a pointer to an extension-specific structure.
• shadingRateImageEnable – specifies whether shading rate image and palettes are used during rasterization.
• viewportCount – specifies the number of per-viewport palettes used to translate values stored in shading rate images.
• 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.

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 and 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGNOF The struct alignment in bytes.
static int	PNEXT The struct member offsets.
static int	PSHADINGRATEPALETTES The struct member offsets.
static int	SHADINGRATEIMAGEENABLE The struct member offsets.
static int	SIZEOF The struct size in bytes.
static int	STYPE The struct member offsets.
static int	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 and Description
VkPipelineViewportShadingRateImageStateCreateInfoNV(java.nio.ByteBuffer container) Creates a VkPipelineViewportShadingRateImageStateCreateInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method and 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	callocStack() Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer	callocStack(int capacity) Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer	callocStack(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	callocStack(org.lwjgl.system.MemoryStack stack) Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
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	mallocStack() Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the thread-local MemoryStack.
static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer	mallocStack(int capacity) Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack.
static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkPipelineViewportShadingRateImageStateCreateInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack) Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the specified MemoryStack.
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() Returns the value of the pNext field.
VkPipelineViewportShadingRateImageStateCreateInfoNV	pNext(long value) Sets the specified value to the pNext field.
VkShadingRatePaletteNV.Buffer	pShadingRatePalettes() Returns a VkShadingRatePaletteNV.Buffer view of the struct array pointed to by the pShadingRatePalettes field.
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() Returns the value of the shadingRateImageEnable field.
VkPipelineViewportShadingRateImageStateCreateInfoNV	shadingRateImageEnable(boolean value) Sets the specified value to the shadingRateImageEnable field.
int	sizeof()
int	sType() Returns the value of the sType field.
VkPipelineViewportShadingRateImageStateCreateInfoNV	sType(int value) Sets the specified value to the sType field.
int	viewportCount() Returns the value of the viewportCount field.
VkPipelineViewportShadingRateImageStateCreateInfoNV	viewportCount(int value) Sets the specified value to the viewportCount field.

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.

SHADINGRATEIMAGEENABLE

public static final int SHADINGRATEIMAGEENABLE

The struct member offsets.

VIEWPORTCOUNT

public static final int VIEWPORTCOUNT

The struct member offsets.

PSHADINGRATEPALETTES

public static final int 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()

Returns the value of the sType field.

pNext

public long pNext()

Returns the value of the pNext field.

shadingRateImageEnable

public boolean shadingRateImageEnable()

Returns the value of the shadingRateImageEnable field.

viewportCount

public int viewportCount()

Returns the value of the viewportCount field.

pShadingRatePalettes

@Nullable
public VkShadingRatePaletteNV.Buffer pShadingRatePalettes()

Returns a VkShadingRatePaletteNV.Buffer view of the struct array pointed to by the pShadingRatePalettes field.

sType

public VkPipelineViewportShadingRateImageStateCreateInfoNV sType(int value)

Sets the specified 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

public static VkPipelineViewportShadingRateImageStateCreateInfoNV mallocStack()

Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the thread-local MemoryStack.

callocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV callocStack()

Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack

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

Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV callocStack(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

mallocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer mallocStack(int capacity)

Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer callocStack(int capacity)

Returns a new VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer mallocStack(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

callocStack

public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer callocStack(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.