Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFragmentShadingRateAttachmentInfoKHR

extends Struct<VkFragmentShadingRateAttachmentInfoKHR>
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 fragment shading rate attachment for a subpass.
Description

If no shading rate attachment is specified, 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

VkAttachmentReference2, VkExtent2D

Layout


struct VkFragmentShadingRateAttachmentInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkAttachmentReference2 const * pFragmentShadingRateAttachment;
    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
PFRAGMENTSHADINGRATEATTACHMENT

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkFragmentShadingRateAttachmentInfoKHR
calloc()

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with memCalloc.

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

public static VkFragmentShadingRateAttachmentInfoKHR
create(long address)

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

public static VkFragmentShadingRateAttachmentInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkFragmentShadingRateAttachmentInfoKHR
malloc()

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with memAlloc.

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkAttachmentReference2
public static void
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 VkAttachmentReference2
pFragmentShadingRateAttachment()

NULL or a pointer to a VkAttachmentReference2 structure defining the fragment shading rate attachment for this subpass.

public VkFragmentShadingRateAttachmentInfoKHR
public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkFragmentShadingRateAttachmentInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkFragmentShadingRateAttachmentInfoKHR
set(int sType, long pNext, VkAttachmentReference2 pFragmentShadingRateAttachment, VkExtent2D shadingRateAttachmentTexelSize)

Initializes this struct with the specified values.

public VkFragmentShadingRateAttachmentInfoKHR

Returns:

this struct
set
(VkFragmentShadingRateAttachmentInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public VkExtent2D
shadingRateAttachmentTexelSize()

specifies the size of the portion of the framebuffer corresponding to each texel in pFragmentShadingRateAttachment.

public VkFragmentShadingRateAttachmentInfoKHR
public VkFragmentShadingRateAttachmentInfoKHR
public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkFragmentShadingRateAttachmentInfoKHR
sType(int value)

Sets the specified value to the sType field.

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

PFRAGMENTSHADINGRATEATTACHMENTback to summary
public static final int PFRAGMENTSHADINGRATEATTACHMENT

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

VkFragmentShadingRateAttachmentInfoKHRback to summary
protected VkFragmentShadingRateAttachmentInfoKHR(long address, ByteBuffer container)
VkFragmentShadingRateAttachmentInfoKHRback to summary
public VkFragmentShadingRateAttachmentInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFragmentShadingRateAttachmentInfoKHR calloc(MemoryStack stack)

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR.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 VkFragmentShadingRateAttachmentInfoKHR 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 VkFragmentShadingRateAttachmentInfoKHR create()

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkFragmentShadingRateAttachmentInfoKHR create(long address)

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

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

Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFragmentShadingRateAttachmentInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFragmentShadingRateAttachmentInfoKHR malloc(MemoryStack stack)

Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npFragmentShadingRateAttachmentback to summary
public static VkAttachmentReference2 npFragmentShadingRateAttachment(long struct)

Unsafe version of pFragmentShadingRateAttachment.

Annotations
@Nullable
npFragmentShadingRateAttachmentback to summary
public static void npFragmentShadingRateAttachment(long struct, VkAttachmentReference2 value)

Unsafe version of pFragmentShadingRateAttachment.

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.

pFragmentShadingRateAttachmentback to summary
public VkAttachmentReference2 pFragmentShadingRateAttachment()

NULL or a pointer to a VkAttachmentReference2 structure defining the fragment shading rate attachment for this subpass.

Annotations
@Nullable
@NativeType:VkAttachmentReference2 const *
pFragmentShadingRateAttachmentback to summary
public VkFragmentShadingRateAttachmentInfoKHR pFragmentShadingRateAttachment(VkAttachmentReference2 value)

Sets the address of the specified VkAttachmentReference2 to the pFragmentShadingRateAttachment field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkFragmentShadingRateAttachmentInfoKHR set(int sType, long pNext, VkAttachmentReference2 pFragmentShadingRateAttachment, VkExtent2D shadingRateAttachmentTexelSize)

Initializes this struct with the specified values.

setback to summary
public VkFragmentShadingRateAttachmentInfoKHR set(VkFragmentShadingRateAttachmentInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkFragmentShadingRateAttachmentInfoKHR

the source struct

Returns:VkFragmentShadingRateAttachmentInfoKHR

this struct

shadingRateAttachmentTexelSizeback to summary
public VkExtent2D shadingRateAttachmentTexelSize()

specifies the size of the portion of the framebuffer corresponding to each texel in pFragmentShadingRateAttachment.

shadingRateAttachmentTexelSizeback to summary
public VkFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(VkExtent2D value)

Copies the specified VkExtent2D to the shadingRateAttachmentTexelSize field.

shadingRateAttachmentTexelSizeback to summary
public VkFragmentShadingRateAttachmentInfoKHR 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 VkFragmentShadingRateAttachmentInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkFragmentShadingRateAttachmentInfoKHR.Buffer

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

An array of VkFragmentShadingRateAttachmentInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkFragmentShadingRateAttachmentInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkFragmentShadingRateAttachmentInfoKHR.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 VkFragmentShadingRateAttachmentInfoKHR
public VkAttachmentReference2
public VkFragmentShadingRateAttachmentInfoKHR.Buffer
public long

Returns:

the value of the VkFragmentShadingRateAttachmentInfoKHR#pNext field.
pNext
()

public VkFragmentShadingRateAttachmentInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkFragmentShadingRateAttachmentInfoKHR#pNext field.

protected VkFragmentShadingRateAttachmentInfoKHR.Buffer
public VkExtent2D
public VkFragmentShadingRateAttachmentInfoKHR.Buffer
public VkFragmentShadingRateAttachmentInfoKHR.Buffer
public int

Returns:

the value of the VkFragmentShadingRateAttachmentInfoKHR#sType field.
sType
()

public VkFragmentShadingRateAttachmentInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkFragmentShadingRateAttachmentInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFragmentShadingRateAttachmentInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
pFragmentShadingRateAttachmentback to summary
public VkAttachmentReference2 pFragmentShadingRateAttachment()
Returns:VkAttachmentReference2

a VkAttachmentReference2 view of the struct pointed to by the VkFragmentShadingRateAttachmentInfoKHR#pFragmentShadingRateAttachment field.

Annotations
@Nullable
@NativeType:VkAttachmentReference2 const *
pFragmentShadingRateAttachmentback to summary
public VkFragmentShadingRateAttachmentInfoKHR.Buffer pFragmentShadingRateAttachment(VkAttachmentReference2 value)

Sets the address of the specified VkAttachmentReference2 to the VkFragmentShadingRateAttachmentInfoKHR#pFragmentShadingRateAttachment field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkFragmentShadingRateAttachmentInfoKHR#pNext field.

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

Sets the specified value to the VkFragmentShadingRateAttachmentInfoKHR#pNext field.

selfback to summary
protected VkFragmentShadingRateAttachmentInfoKHR.Buffer self()

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

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

a VkExtent2D view of the VkFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field.

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

Copies the specified VkExtent2D to the VkFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field.

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

Passes the VkFragmentShadingRateAttachmentInfoKHR#shadingRateAttachmentTexelSize field to the specified Consumer.

sTypeback to summary
public int sType()
Returns:int

the value of the VkFragmentShadingRateAttachmentInfoKHR#sType field.

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

Sets the specified value to the VkFragmentShadingRateAttachmentInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the VkFragmentShadingRateAttachmentInfoKHR#sType field.