Package org.lwjgl.vulkan

Class VkShadingRatePaletteNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkShadingRatePaletteNV>

org.lwjgl.vulkan.VkShadingRatePaletteNV

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkShadingRatePaletteNV
extends Struct<VkShadingRatePaletteNV>
implements 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

Layout

 struct VkShadingRatePaletteNV {
     uint32_t shadingRatePaletteEntryCount();
     VkShadingRatePaletteEntryNV const * pShadingRatePaletteEntries();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkShadingRatePaletteNV.Buffer	An array of VkShadingRatePaletteNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PSHADINGRATEPALETTEENTRIES	The struct member offsets.
static final int	SHADINGRATEPALETTEENTRYCOUNT	The struct member offsets.
static final 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	Description
VkShadingRatePaletteNV(ByteBuffer container)	Creates a VkShadingRatePaletteNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkShadingRatePaletteNV	calloc(MemoryStack stack)	Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkShadingRatePaletteNV	callocStack()	Deprecated.
static VkShadingRatePaletteNV.Buffer	callocStack(int capacity)	Deprecated.
static VkShadingRatePaletteNV.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkShadingRatePaletteNV	callocStack(MemoryStack stack)	Deprecated.
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the specified MemoryStack.
static VkShadingRatePaletteNV	malloc(MemoryStack stack)	Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack.
static VkShadingRatePaletteNV	mallocStack()	Deprecated.
static VkShadingRatePaletteNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkShadingRatePaletteNV.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkShadingRatePaletteNV	mallocStack(MemoryStack stack)	Deprecated.
static IntBuffer	npShadingRatePaletteEntries(long struct)	Unsafe version of pShadingRatePaletteEntries.
static void	npShadingRatePaletteEntries(long struct, 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.
IntBuffer	pShadingRatePaletteEntries()	a pointer to an array of VkShadingRatePaletteEntryNV enums defining the shading rate for each palette entry.
VkShadingRatePaletteNV	pShadingRatePaletteEntries(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()	specifies the number of entries in the shading rate image palette.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

VkShadingRatePaletteNV

public VkShadingRatePaletteNV(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkShadingRatePaletteNV>

shadingRatePaletteEntryCount

public int shadingRatePaletteEntryCount()

specifies the number of entries in the shading rate image palette.

pShadingRatePaletteEntries

public IntBuffer pShadingRatePaletteEntries()

a pointer to an array of VkShadingRatePaletteEntryNV enums defining the shading rate for each palette entry.

pShadingRatePaletteEntries

public VkShadingRatePaletteNV pShadingRatePaletteEntries(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

@Deprecated
public static VkShadingRatePaletteNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkShadingRatePaletteNV callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkShadingRatePaletteNV mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkShadingRatePaletteNV callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkShadingRatePaletteNV.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkShadingRatePaletteNV.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkShadingRatePaletteNV malloc(MemoryStack stack)

Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkShadingRatePaletteNV calloc(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

malloc

public static VkShadingRatePaletteNV.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkShadingRatePaletteNV.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nshadingRatePaletteEntryCount

public static int nshadingRatePaletteEntryCount(long struct)

Unsafe version of shadingRatePaletteEntryCount().

npShadingRatePaletteEntries

public static 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,
 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