Package org.lwjgl.vulkan

Class VkRenderingFragmentShadingRateAttachmentInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingFragmentShadingRateAttachmentInfoKHR>

org.lwjgl.vulkan.VkRenderingFragmentShadingRateAttachmentInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkRenderingFragmentShadingRateAttachmentInfoKHR
extends org.lwjgl.system.Struct<VkRenderingFragmentShadingRateAttachmentInfoKHR>
implements org.lwjgl.system.NativeResource

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

• If imageView is not NULL_HANDLE, layout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
• If imageView is not NULL_HANDLE, it must have been created with IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be a power of two value
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.width
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.width
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be a power of two value
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.height
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.height
• If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.width and shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
• If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.height and shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• If imageView is not NULL_HANDLE, imageView must be a valid VkImageView handle
• imageLayout must be a valid VkImageLayout value

See Also

VkExtent2D

Layout

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

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IMAGELAYOUT	The struct member offsets.
static final int	IMAGEVIEW	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SHADINGRATEATTACHMENTTEXELSIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkRenderingFragmentShadingRateAttachmentInfoKHR(ByteBuffer container)	Creates a VkRenderingFragmentShadingRateAttachmentInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkRenderingFragmentShadingRateAttachmentInfoKHR	calloc()	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with memCalloc.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	calloc(int capacity)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memCalloc.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingFragmentShadingRateAttachmentInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingFragmentShadingRateAttachmentInfoKHR	create()	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	create(int capacity)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.
static VkRenderingFragmentShadingRateAttachmentInfoKHR	create(long address)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	create(long address, int capacity)	Create a VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.
static @Nullable VkRenderingFragmentShadingRateAttachmentInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageLayout()	the layout that imageView will be in during rendering.
VkRenderingFragmentShadingRateAttachmentInfoKHR	imageLayout(int value)	Sets the specified value to the imageLayout() field.
long	imageView()	the image view that will be used as a fragment shading rate attachment.
VkRenderingFragmentShadingRateAttachmentInfoKHR	imageView(long value)	Sets the specified value to the imageView() field.
static VkRenderingFragmentShadingRateAttachmentInfoKHR	malloc()	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with memAlloc.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	malloc(int capacity)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memAlloc.
static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkRenderingFragmentShadingRateAttachmentInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.
static int	nimageLayout(long struct)	Unsafe version of imageLayout().
static void	nimageLayout(long struct, int value)	Unsafe version of imageLayout.
static long	nimageView(long struct)	Unsafe version of imageView().
static void	nimageView(long struct, long value)	Unsafe version of imageView.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkExtent2D	nshadingRateAttachmentTexelSize(long struct)	Unsafe version of shadingRateAttachmentTexelSize().
static void	nshadingRateAttachmentTexelSize(long struct, VkExtent2D value)	Unsafe version of shadingRateAttachmentTexelSize.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRenderingFragmentShadingRateAttachmentInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderingFragmentShadingRateAttachmentInfoKHR	set(int sType, long pNext, long imageView, int imageLayout, VkExtent2D shadingRateAttachmentTexelSize)	Initializes this struct with the specified values.
VkRenderingFragmentShadingRateAttachmentInfoKHR	set(VkRenderingFragmentShadingRateAttachmentInfoKHR src)	Copies the specified struct data to this struct.
VkExtent2D	shadingRateAttachmentTexelSize()	specifies the number of pixels corresponding to each texel in imageView.
VkRenderingFragmentShadingRateAttachmentInfoKHR	shadingRateAttachmentTexelSize(Consumer<VkExtent2D> consumer)	Passes the shadingRateAttachmentTexelSize() field to the specified Consumer.
VkRenderingFragmentShadingRateAttachmentInfoKHR	shadingRateAttachmentTexelSize(VkExtent2D value)	Copies the specified VkExtent2D to the shadingRateAttachmentTexelSize() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkRenderingFragmentShadingRateAttachmentInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkRenderingFragmentShadingRateAttachmentInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

IMAGEVIEW

public static final int IMAGEVIEW

The struct member offsets.

IMAGELAYOUT

public static final int IMAGELAYOUT

The struct member offsets.

SHADINGRATEATTACHMENTTEXELSIZE

public static final int SHADINGRATEATTACHMENTTEXELSIZE

The struct member offsets.

Constructor Details

VkRenderingFragmentShadingRateAttachmentInfoKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkRenderingFragmentShadingRateAttachmentInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageView

public long imageView()

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

imageLayout

public int imageLayout()

the layout that imageView will be in during rendering.

shadingRateAttachmentTexelSize

public VkExtent2D shadingRateAttachmentTexelSize()

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

sType

public VkRenderingFragmentShadingRateAttachmentInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderingFragmentShadingRateAttachmentInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the sType() field.

pNext

public VkRenderingFragmentShadingRateAttachmentInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

imageView

public VkRenderingFragmentShadingRateAttachmentInfoKHR imageView(long value)

Sets the specified value to the imageView() field.

imageLayout

public VkRenderingFragmentShadingRateAttachmentInfoKHR imageLayout(int value)

Sets the specified value to the imageLayout() field.

shadingRateAttachmentTexelSize

public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(VkExtent2D value)

Copies the specified VkExtent2D to the shadingRateAttachmentTexelSize() field.

shadingRateAttachmentTexelSize

public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(Consumer<VkExtent2D> consumer)

Passes the shadingRateAttachmentTexelSize() field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkRenderingFragmentShadingRateAttachmentInfoKHR set(VkRenderingFragmentShadingRateAttachmentInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc()

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

calloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR calloc()

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

create

public static VkRenderingFragmentShadingRateAttachmentInfoKHR create()

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

create

public static VkRenderingFragmentShadingRateAttachmentInfoKHR create(long address)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkRenderingFragmentShadingRateAttachmentInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer create(int capacity)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkRenderingFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nimageView

public static long nimageView(long struct)

Unsafe version of imageView().

nimageLayout

public static int nimageLayout(long struct)

Unsafe version of imageLayout().

nshadingRateAttachmentTexelSize

public static VkExtent2D nshadingRateAttachmentTexelSize(long struct)

Unsafe version of shadingRateAttachmentTexelSize().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nimageView

public static void nimageView(long struct,
 long value)

Unsafe version of imageView.

nimageLayout

public static void nimageLayout(long struct,
 int value)

Unsafe version of imageLayout.

nshadingRateAttachmentTexelSize

public static void nshadingRateAttachmentTexelSize(long struct,
 VkExtent2D value)

Unsafe version of shadingRateAttachmentTexelSize.