Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRenderingFragmentShadingRateAttachmentInfoKHR

extends Struct<VkRenderingFragmentShadingRateAttachmentInfoKHR>
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 fragment shading rate attachment information.
Description

This structure can be included in the pNext chain of VkRenderingInfo to define a fragment shading rate attachment. If imageView is NULL_HANDLE, or if this structure is not specified, the implementation behaves as if a valid shading rate attachment was specified with all texels specifying a single pixel per fragment.

Valid Usage
Valid Usage (Implicit)
See Also

VkExtent2D

Layout


struct VkRenderingFragmentShadingRateAttachmentInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkImageView imageView;
    VkImageLayout imageLayout;
    VkExtent2D shadingRateAttachmentTexelSize;
}

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
IMAGELAYOUT

The struct member offsets.

public static final int
IMAGEVIEW

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SHADINGRATEATTACHMENTTEXELSIZE

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
VkRenderingFragmentShadingRateAttachmentInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkRenderingFragmentShadingRateAttachmentInfoKHR
calloc()

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with memCalloc.

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkRenderingFragmentShadingRateAttachmentInfoKHR
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 VkRenderingFragmentShadingRateAttachmentInfoKHR
create()

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

public static VkRenderingFragmentShadingRateAttachmentInfoKHR
create(long address)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

public static VkRenderingFragmentShadingRateAttachmentInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageLayout()

the layout that imageView will be in during rendering.

public VkRenderingFragmentShadingRateAttachmentInfoKHR
imageLayout(int value)

Sets the specified value to the imageLayout field.

public long
imageView()

the image view that will be used as a fragment shading rate attachment.

public VkRenderingFragmentShadingRateAttachmentInfoKHR
imageView(long value)

Sets the specified value to the imageView field.

public static VkRenderingFragmentShadingRateAttachmentInfoKHR
malloc()

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with memAlloc.

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

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

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

public static int
nimageLayout(long struct)

Unsafe version of imageLayout.

public static void
nimageLayout(long struct, int value)

Unsafe version of imageLayout.

public static long
nimageView(long struct)

Unsafe version of imageView.

public static void
nimageView(long struct, long value)

Unsafe version of imageView.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkExtent2D
public static void
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 VkRenderingFragmentShadingRateAttachmentInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkRenderingFragmentShadingRateAttachmentInfoKHR
set(int sType, long pNext, long imageView, int imageLayout, VkExtent2D shadingRateAttachmentTexelSize)

Initializes this struct with the specified values.

public VkRenderingFragmentShadingRateAttachmentInfoKHR

Returns:

this struct
set
(VkRenderingFragmentShadingRateAttachmentInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public VkExtent2D
shadingRateAttachmentTexelSize()

specifies the number of pixels corresponding to each texel in imageView.

public VkRenderingFragmentShadingRateAttachmentInfoKHR
public VkRenderingFragmentShadingRateAttachmentInfoKHR
public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkRenderingFragmentShadingRateAttachmentInfoKHR
sType(int value)

Sets the specified value to the sType field.

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

IMAGELAYOUTback to summary
public static final int IMAGELAYOUT

The struct member offsets.

IMAGEVIEWback to summary
public static final int IMAGEVIEW

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SHADINGRATEATTACHMENTTEXELSIZEback to summary
public static final int SHADINGRATEATTACHMENTTEXELSIZE

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

VkRenderingFragmentShadingRateAttachmentInfoKHRback to summary
protected VkRenderingFragmentShadingRateAttachmentInfoKHR(long address, ByteBuffer container)
VkRenderingFragmentShadingRateAttachmentInfoKHRback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRenderingFragmentShadingRateAttachmentInfoKHR calloc(MemoryStack stack)

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.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

createback to summary
protected VkRenderingFragmentShadingRateAttachmentInfoKHR 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 VkRenderingFragmentShadingRateAttachmentInfoKHR create()

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkRenderingFragmentShadingRateAttachmentInfoKHR create(long address)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

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

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRenderingFragmentShadingRateAttachmentInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageLayoutback to summary
public int imageLayout()

the layout that imageView will be in during rendering.

Annotations
@NativeType:VkImageLayout
imageLayoutback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR imageLayout(int value)

Sets the specified value to the imageLayout field.

imageViewback to summary
public long imageView()

the image view that will be used as a fragment shading rate attachment.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR imageView(long value)

Sets the specified value to the imageView field.

mallocback to summary
public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc(MemoryStack stack)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nimageLayoutback to summary
public static int nimageLayout(long struct)

Unsafe version of imageLayout.

nimageLayoutback to summary
public static void nimageLayout(long struct, int value)

Unsafe version of imageLayout.

nimageViewback to summary
public static long nimageView(long struct)

Unsafe version of imageView.

nimageViewback to summary
public static void nimageView(long struct, long value)

Unsafe version of imageView.

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.

nshadingRateAttachmentTexelSizeback to summary
public static VkExtent2D nshadingRateAttachmentTexelSize(long struct)

Unsafe version of shadingRateAttachmentTexelSize.

nshadingRateAttachmentTexelSizeback to summary
public static void nshadingRateAttachmentTexelSize(long struct, VkExtent2D value)

Unsafe version of shadingRateAttachmentTexelSize.

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 const *
pNextback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR set(int sType, long pNext, long imageView, int imageLayout, VkExtent2D shadingRateAttachmentTexelSize)

Initializes this struct with the specified values.

setback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR set(VkRenderingFragmentShadingRateAttachmentInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkRenderingFragmentShadingRateAttachmentInfoKHR

the source struct

Returns:VkRenderingFragmentShadingRateAttachmentInfoKHR

this struct

shadingRateAttachmentTexelSizeback to summary
public VkExtent2D shadingRateAttachmentTexelSize()

specifies the number of pixels corresponding to each texel in imageView.

shadingRateAttachmentTexelSizeback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(VkExtent2D value)

Copies the specified VkExtent2D to the shadingRateAttachmentTexelSize field.

shadingRateAttachmentTexelSizeback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(Consumer<VkExtent2D> consumer)

Passes the shadingRateAttachmentTexelSize field to the specified Consumer.

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 VkRenderingFragmentShadingRateAttachmentInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer

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

An array of VkRenderingFragmentShadingRateAttachmentInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkRenderingFragmentShadingRateAttachmentInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRenderingFragmentShadingRateAttachmentInfoKHR.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 VkRenderingFragmentShadingRateAttachmentInfoKHR
public int
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer
imageLayout(int value)

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageLayout field.

public long
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer
imageView(long value)

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageView field.

public long
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#pNext field.

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

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRenderingFragmentShadingRateAttachmentInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
imageLayoutback to summary
public int imageLayout()
Returns:int

the value of the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageLayout field.

Annotations
@NativeType:VkImageLayout
imageLayoutback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer imageLayout(int value)

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageLayout field.

imageViewback to summary
public long imageView()
Returns:long

the value of the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageView field.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer imageView(long value)

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#imageView field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkRenderingFragmentShadingRateAttachmentInfoKHR#pNext field.

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

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#pNext field.

selfback to summary
protected VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer self()

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

Annotations
@Override
shadingRateAttachmentTexelSizeback to summary
public VkExtent2D shadingRateAttachmentTexelSize()
Returns:VkExtent2D

a VkExtent2D view of the VkRenderingFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field.

shadingRateAttachmentTexelSizeback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer shadingRateAttachmentTexelSize(VkExtent2D value)

Copies the specified VkExtent2D to the VkRenderingFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field.

shadingRateAttachmentTexelSizeback to summary
public VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer shadingRateAttachmentTexelSize(Consumer<VkExtent2D> consumer)

Passes the VkRenderingFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field to the specified Consumer.

sTypeback to summary
public int sType()
Returns:int

the value of the VkRenderingFragmentShadingRateAttachmentInfoKHR#sType field.

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

Sets the specified value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the VkRenderingFragmentShadingRateAttachmentInfoKHR#sType field.