Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceShadingRateImagePropertiesNV

extends Struct<VkPhysicalDeviceShadingRateImagePropertiesNV>
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 describing shading rate image limits that can be supported by an implementation.
Description

If the VkPhysicalDeviceShadingRateImagePropertiesNV structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

These properties are related to the shading rate image feature.

Valid Usage (Implicit)
See Also

VkExtent2D

Layout


struct VkPhysicalDeviceShadingRateImagePropertiesNV {
    VkStructureType sType;
    void * pNext;
    VkExtent2D shadingRateTexelSize;
    uint32_t shadingRatePaletteSize;
    uint32_t shadingRateMaxCoarseSamples;
}

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
PNEXT

The struct member offsets.

public static final int
SHADINGRATEMAXCOARSESAMPLES

The struct member offsets.

public static final int
SHADINGRATEPALETTESIZE

The struct member offsets.

public static final int
SHADINGRATETEXELSIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPhysicalDeviceShadingRateImagePropertiesNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceShadingRateImagePropertiesNV
calloc()

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPhysicalDeviceShadingRateImagePropertiesNV
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceShadingRateImagePropertiesNV
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 VkPhysicalDeviceShadingRateImagePropertiesNV
create()

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated with BufferUtils.

public static VkPhysicalDeviceShadingRateImagePropertiesNV
create(long address)

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance at the specified memory.

public static VkPhysicalDeviceShadingRateImagePropertiesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceShadingRateImagePropertiesNV
malloc()

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated on the specified MemoryStack.

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

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

public static VkPhysicalDeviceShadingRateImagePropertiesNV
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
public static int
nshadingRatePaletteSize(long struct)

Unsafe version of shadingRatePaletteSize.

public static VkExtent2D
nshadingRateTexelSize(long struct)

Unsafe version of shadingRateTexelSize.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceShadingRateImagePropertiesNV
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceShadingRateImagePropertiesNV
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceShadingRateImagePropertiesNV

Returns:

this struct
set
(VkPhysicalDeviceShadingRateImagePropertiesNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
shadingRateMaxCoarseSamples()

specifies the maximum number of coverage samples supported in a single fragment.

public int
shadingRatePaletteSize()

indicates the maximum number of palette entries supported for the shading rate image.

public VkExtent2D
shadingRateTexelSize()

indicates the width and height of the portion of the framebuffer corresponding to each texel in the shading rate image.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPhysicalDeviceShadingRateImagePropertiesNV
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceShadingRateImagePropertiesNV
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SHADINGRATEMAXCOARSESAMPLESback to summary
public static final int SHADINGRATEMAXCOARSESAMPLES

The struct member offsets.

SHADINGRATEPALETTESIZEback to summary
public static final int SHADINGRATEPALETTESIZE

The struct member offsets.

SHADINGRATETEXELSIZEback to summary
public static final int SHADINGRATETEXELSIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPhysicalDeviceShadingRateImagePropertiesNVback to summary
protected VkPhysicalDeviceShadingRateImagePropertiesNV(long address, ByteBuffer container)
VkPhysicalDeviceShadingRateImagePropertiesNVback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV(ByteBuffer container)

Creates a VkPhysicalDeviceShadingRateImagePropertiesNV 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 VkPhysicalDeviceShadingRateImagePropertiesNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceShadingRateImagePropertiesNV calloc(MemoryStack stack)

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV 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 VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.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 VkPhysicalDeviceShadingRateImagePropertiesNV callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPhysicalDeviceShadingRateImagePropertiesNV.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 VkPhysicalDeviceShadingRateImagePropertiesNV 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 VkPhysicalDeviceShadingRateImagePropertiesNV create()

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceShadingRateImagePropertiesNV create(long address)

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceShadingRateImagePropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceShadingRateImagePropertiesNV malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkPhysicalDeviceShadingRateImagePropertiesNV.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 VkPhysicalDeviceShadingRateImagePropertiesNV mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nshadingRateMaxCoarseSamplesback to summary
public static int nshadingRateMaxCoarseSamples(long struct)

Unsafe version of shadingRateMaxCoarseSamples.

nshadingRatePaletteSizeback to summary
public static int nshadingRatePaletteSize(long struct)

Unsafe version of shadingRatePaletteSize.

nshadingRateTexelSizeback to summary
public static VkExtent2D nshadingRateTexelSize(long struct)

Unsafe version of shadingRateTexelSize.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV set(VkPhysicalDeviceShadingRateImagePropertiesNV src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceShadingRateImagePropertiesNV

the source struct

Returns:VkPhysicalDeviceShadingRateImagePropertiesNV

this struct

shadingRateMaxCoarseSamplesback to summary
public int shadingRateMaxCoarseSamples()

specifies the maximum number of coverage samples supported in a single fragment. If the product of the fragment size derived from the base shading rate and the number of coverage samples per pixel exceeds this limit, the final shading rate will be adjusted so that its product does not exceed the limit.

Annotations
@NativeType:uint32_t
shadingRatePaletteSizeback to summary
public int shadingRatePaletteSize()

indicates the maximum number of palette entries supported for the shading rate image.

Annotations
@NativeType:uint32_t
shadingRateTexelSizeback to summary
public VkExtent2D shadingRateTexelSize()

indicates the width and height of the portion of the framebuffer corresponding to each texel in the shading rate image.

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADING_RATE_IMAGE_PROPERTIES_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer

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

An array of VkPhysicalDeviceShadingRateImagePropertiesNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceShadingRateImagePropertiesNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceShadingRateImagePropertiesNV.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 VkPhysicalDeviceShadingRateImagePropertiesNV
public long
public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceShadingRateImagePropertiesNV#pNext field.

protected VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer
public int
public int
public VkExtent2D
public int
public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceShadingRateImagePropertiesNV#sType field.

public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceShadingRateImagePropertiesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceShadingRateImagePropertiesNV.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 VkPhysicalDeviceShadingRateImagePropertiesNV#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 VkPhysicalDeviceShadingRateImagePropertiesNV getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceShadingRateImagePropertiesNV#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer pNext(long value)

Sets the specified value to the VkPhysicalDeviceShadingRateImagePropertiesNV#pNext field.

selfback to summary
protected VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer self()

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

Annotations
@Override
shadingRateMaxCoarseSamplesback to summary
public int shadingRateMaxCoarseSamples()
Returns:int

the value of the VkPhysicalDeviceShadingRateImagePropertiesNV#shadingRateMaxCoarseSamples field.

Annotations
@NativeType:uint32_t
shadingRatePaletteSizeback to summary
public int shadingRatePaletteSize()
Returns:int

the value of the VkPhysicalDeviceShadingRateImagePropertiesNV#shadingRatePaletteSize field.

Annotations
@NativeType:uint32_t
shadingRateTexelSizeback to summary
public VkExtent2D shadingRateTexelSize()
Returns:VkExtent2D

a VkExtent2D view of the VkPhysicalDeviceShadingRateImagePropertiesNV#shadingRateTexelSize field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceShadingRateImagePropertiesNV#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer sType(int value)

Sets the specified value to the VkPhysicalDeviceShadingRateImagePropertiesNV#sType field.

sType$Defaultback to summary
public VkPhysicalDeviceShadingRateImagePropertiesNV.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADING_RATE_IMAGE_PROPERTIES_NV value to the VkPhysicalDeviceShadingRateImagePropertiesNV#sType field.