Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkShadingRatePaletteNV

extends Struct<VkShadingRatePaletteNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a single shading rate palette.
Valid Usage
Valid Usage (Implicit)
See Also

VkPipelineViewportShadingRateImageStateCreateInfoNV, CmdSetViewportShadingRatePaletteNV

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PSHADINGRATEPALETTEENTRIES

The struct member offsets.

public static final int
SHADINGRATEPALETTEENTRYCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkShadingRatePaletteNV(long address, ByteBuffer container)

public
VkShadingRatePaletteNV(ByteBuffer container)

Creates a VkShadingRatePaletteNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkShadingRatePaletteNV
calloc()

Returns a new VkShadingRatePaletteNV instance allocated with memCalloc.

public static VkShadingRatePaletteNV.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memCalloc.

public static VkShadingRatePaletteNV
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkShadingRatePaletteNV.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkShadingRatePaletteNV
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkShadingRatePaletteNV
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkShadingRatePaletteNV
create()

Returns a new VkShadingRatePaletteNV instance allocated with BufferUtils.

public static VkShadingRatePaletteNV
create(long address)

Returns a new VkShadingRatePaletteNV instance for the specified memory address.

public static VkShadingRatePaletteNV.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with BufferUtils.

public static VkShadingRatePaletteNV.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkShadingRatePaletteNV.Buffer instance at the specified memory.

public static VkShadingRatePaletteNV
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkShadingRatePaletteNV.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkShadingRatePaletteNV
malloc()

Returns a new VkShadingRatePaletteNV instance allocated with memAlloc.

public static VkShadingRatePaletteNV.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memAlloc.

public static VkShadingRatePaletteNV
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack.

public static VkShadingRatePaletteNV.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkShadingRatePaletteNV
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkShadingRatePaletteNV.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static IntBuffer
public static void
public static int
public static void
nshadingRatePaletteEntryCount(long struct, int value)

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

public IntBuffer
pShadingRatePaletteEntries()

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

public VkShadingRatePaletteNV
pShadingRatePaletteEntries(IntBuffer value)

Sets the address of the specified IntBuffer to the pShadingRatePaletteEntries field.

public VkShadingRatePaletteNV

Returns:

this struct
set
(VkShadingRatePaletteNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
shadingRatePaletteEntryCount()

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

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PSHADINGRATEPALETTEENTRIESback to summary
public static final int PSHADINGRATEPALETTEENTRIES

The struct member offsets.

SHADINGRATEPALETTEENTRYCOUNTback to summary
public static final int SHADINGRATEPALETTEENTRYCOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkShadingRatePaletteNVback to summary
protected VkShadingRatePaletteNV(long address, ByteBuffer container)
VkShadingRatePaletteNVback to summary
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 Detail

callocback to summary
public static VkShadingRatePaletteNV calloc()

Returns a new VkShadingRatePaletteNV instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkShadingRatePaletteNV.Buffer calloc(int capacity)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkShadingRatePaletteNV callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkShadingRatePaletteNV callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkShadingRatePaletteNV.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkShadingRatePaletteNV.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkShadingRatePaletteNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkShadingRatePaletteNV create()

Returns a new VkShadingRatePaletteNV instance allocated with BufferUtils.

createback to summary
public static VkShadingRatePaletteNV create(long address)

Returns a new VkShadingRatePaletteNV instance for the specified memory address.

createback to summary
public static VkShadingRatePaletteNV.Buffer create(int capacity)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkShadingRatePaletteNV.Buffer create(long address, int capacity)

Create a VkShadingRatePaletteNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkShadingRatePaletteNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkShadingRatePaletteNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkShadingRatePaletteNV malloc()

Returns a new VkShadingRatePaletteNV instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkShadingRatePaletteNV.Buffer malloc(int capacity)

Returns a new VkShadingRatePaletteNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkShadingRatePaletteNV malloc(MemoryStack stack)

Returns a new VkShadingRatePaletteNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkShadingRatePaletteNV mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkShadingRatePaletteNV mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkShadingRatePaletteNV.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkShadingRatePaletteNV.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npShadingRatePaletteEntriesback to summary
public static IntBuffer npShadingRatePaletteEntries(long struct)

Unsafe version of pShadingRatePaletteEntries.

npShadingRatePaletteEntriesback to summary
public static void npShadingRatePaletteEntries(long struct, IntBuffer value)

Unsafe version of pShadingRatePaletteEntries.

nshadingRatePaletteEntryCountback to summary
public static int nshadingRatePaletteEntryCount(long struct)

Unsafe version of shadingRatePaletteEntryCount.

nshadingRatePaletteEntryCountback to summary
public static void nshadingRatePaletteEntryCount(long struct, int value)

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

pShadingRatePaletteEntriesback to summary
public IntBuffer pShadingRatePaletteEntries()

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

Annotations
@NativeType:VkShadingRatePaletteEntryNV const *
pShadingRatePaletteEntriesback to summary
public VkShadingRatePaletteNV pShadingRatePaletteEntries(IntBuffer value)

Sets the address of the specified IntBuffer to the pShadingRatePaletteEntries field.

setback to summary
public VkShadingRatePaletteNV set(VkShadingRatePaletteNV src)

Copies the specified struct data to this struct.

Parameters
src:VkShadingRatePaletteNV

the source struct

Returns:VkShadingRatePaletteNV

this struct

shadingRatePaletteEntryCountback to summary
public int shadingRatePaletteEntryCount()

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

Annotations
@NativeType:uint32_t
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkShadingRatePaletteNV.Buffer

extends StructBuffer<VkShadingRatePaletteNV, VkShadingRatePaletteNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkShadingRatePaletteNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkShadingRatePaletteNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkShadingRatePaletteNV.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkShadingRatePaletteNV
public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkShadingRatePaletteNV#pShadingRatePaletteEntries field.
pShadingRatePaletteEntries
()

public VkShadingRatePaletteNV.Buffer
protected VkShadingRatePaletteNV.Buffer
public int
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkShadingRatePaletteNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkShadingRatePaletteNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkShadingRatePaletteNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkShadingRatePaletteNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pShadingRatePaletteEntriesback to summary
public IntBuffer pShadingRatePaletteEntries()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkShadingRatePaletteNV#pShadingRatePaletteEntries field.

Annotations
@NativeType:VkShadingRatePaletteEntryNV const *
pShadingRatePaletteEntriesback to summary
public VkShadingRatePaletteNV.Buffer pShadingRatePaletteEntries(IntBuffer value)

Sets the address of the specified IntBuffer to the VkShadingRatePaletteNV#pShadingRatePaletteEntries field.

selfback to summary
protected VkShadingRatePaletteNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
shadingRatePaletteEntryCountback to summary
public int shadingRatePaletteEntryCount()
Returns:int

the value of the VkShadingRatePaletteNV#shadingRatePaletteEntryCount field.

Annotations
@NativeType:uint32_t