java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkFragmentShadingRateAttachmentInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkFragmentShadingRateAttachmentInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
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
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, its layout member must be equal to IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be a power of two value
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.width
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.width
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be a power of two value
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.height
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.height
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, the quotient of shadingRateAttachmentTexelSize.width and shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
- If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, the quotient of shadingRateAttachmentTexelSize.height and shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
- If pFragmentShadingRateAttachment is not NULL, pFragmentShadingRateAttachment must be a valid pointer to a valid VkAttachmentReference2 structure
See Also

VkAttachmentReference2, VkExtent2D

Layout
```
 struct VkFragmentShadingRateAttachmentInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkAttachmentReference2 const * pFragmentShadingRateAttachment();
     VkExtent2D shadingRateAttachmentTexelSize();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkFragmentShadingRateAttachmentInfoKHR.Buffer
An array of VkFragmentShadingRateAttachmentInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`PFRAGMENTSHADINGRATEATTACHMENT PNEXT SHADINGRATEATTACHMENTTEXELSIZE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static 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
`VkFragmentShadingRateAttachmentInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkFragmentShadingRateAttachmentInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkFragmentShadingRateAttachmentInfoKHR`	`calloc()`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance allocated with `memCalloc`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFragmentShadingRateAttachmentInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFragmentShadingRateAttachmentInfoKHR`	`create()`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance allocated with `BufferUtils`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkFragmentShadingRateAttachmentInfoKHR`	`create(long address)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance for the specified memory address.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance at the specified memory.
`static VkFragmentShadingRateAttachmentInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkFragmentShadingRateAttachmentInfoKHR`	`malloc()`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance allocated with `memAlloc`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkFragmentShadingRateAttachmentInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkFragmentShadingRateAttachmentInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFragmentShadingRateAttachmentInfoKHR` instance allocated on the specified `MemoryStack`.
`static VkAttachmentReference2`	`npFragmentShadingRateAttachment(long struct)`	Unsafe version of `pFragmentShadingRateAttachment()`.
`static void`	`npFragmentShadingRateAttachment(long struct, VkAttachmentReference2 value)`	Unsafe version of `pFragmentShadingRateAttachment`.
`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`.
`VkAttachmentReference2`	`pFragmentShadingRateAttachment()`	`NULL` or a pointer to a `VkAttachmentReference2` structure defining the fragment shading rate attachment for this subpass.
`VkFragmentShadingRateAttachmentInfoKHR`	`pFragmentShadingRateAttachment(VkAttachmentReference2 value)`	Sets the address of the specified `VkAttachmentReference2` to the `pFragmentShadingRateAttachment()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkFragmentShadingRateAttachmentInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkFragmentShadingRateAttachmentInfoKHR`	`set(int sType, long pNext, VkAttachmentReference2 pFragmentShadingRateAttachment, VkExtent2D shadingRateAttachmentTexelSize)`	Initializes this struct with the specified values.
`VkFragmentShadingRateAttachmentInfoKHR`	`set(VkFragmentShadingRateAttachmentInfoKHR src)`	Copies the specified struct data to this struct.
`VkExtent2D`	`shadingRateAttachmentTexelSize()`	specifies the size of the portion of the framebuffer corresponding to each texel in `pFragmentShadingRateAttachment`.
`VkFragmentShadingRateAttachmentInfoKHR`	`shadingRateAttachmentTexelSize(java.util.function.Consumer<VkExtent2D> consumer)`	Passes the `shadingRateAttachmentTexelSize()` field to the specified `Consumer`.
`VkFragmentShadingRateAttachmentInfoKHR`	`shadingRateAttachmentTexelSize(VkExtent2D value)`	Copies the specified `VkExtent2D` to the `shadingRateAttachmentTexelSize()` field.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkFragmentShadingRateAttachmentInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkFragmentShadingRateAttachmentInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR` value to the `sType()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, PFRAGMENTSHADINGRATEATTACHMENT, SHADINGRATEATTACHMENTTEXELSIZE
  
  The struct member offsets.

Constructor Detail
- VkFragmentShadingRateAttachmentInfoKHR
```
public VkFragmentShadingRateAttachmentInfoKHR(java.nio.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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of this structure.

pNext
```
public long pNext()
```
NULL or a pointer to a structure extending this structure.

pFragmentShadingRateAttachment
```
@Nullable
public VkAttachmentReference2 pFragmentShadingRateAttachment()
```
NULL or a pointer to a VkAttachmentReference2 structure defining the fragment shading rate attachment for this subpass.

shadingRateAttachmentTexelSize
```
public VkExtent2D shadingRateAttachmentTexelSize()
```
specifies the size of the portion of the framebuffer corresponding to each texel in pFragmentShadingRateAttachment.

sType

public VkFragmentShadingRateAttachmentInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkFragmentShadingRateAttachmentInfoKHR sType$Default()
```
Sets the STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR value to the sType() field.

pNext

public VkFragmentShadingRateAttachmentInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pFragmentShadingRateAttachment

public VkFragmentShadingRateAttachmentInfoKHR pFragmentShadingRateAttachment(@Nullable
                                                                             VkAttachmentReference2 value)

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

shadingRateAttachmentTexelSize

public VkFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(VkExtent2D value)

Copies the specified VkExtent2D to the shadingRateAttachmentTexelSize() field.

shadingRateAttachmentTexelSize

public VkFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(java.util.function.Consumer<VkExtent2D> consumer)

Passes the shadingRateAttachmentTexelSize() field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkFragmentShadingRateAttachmentInfoKHR set(VkFragmentShadingRateAttachmentInfoKHR src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkFragmentShadingRateAttachmentInfoKHR malloc()
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkFragmentShadingRateAttachmentInfoKHR calloc()
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkFragmentShadingRateAttachmentInfoKHR create()
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated with BufferUtils.

create
```
public static VkFragmentShadingRateAttachmentInfoKHR create(long address)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkFragmentShadingRateAttachmentInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkFragmentShadingRateAttachmentInfoKHR.Buffer malloc(int capacity)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkFragmentShadingRateAttachmentInfoKHR.Buffer create(int capacity)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkFragmentShadingRateAttachmentInfoKHR.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc
```
public static VkFragmentShadingRateAttachmentInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkFragmentShadingRateAttachmentInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
Returns a new VkFragmentShadingRateAttachmentInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

npFragmentShadingRateAttachment

@Nullable
public static VkAttachmentReference2 npFragmentShadingRateAttachment(long struct)

Unsafe version of pFragmentShadingRateAttachment().

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.

npFragmentShadingRateAttachment

public static void npFragmentShadingRateAttachment(long struct,
                                                   @Nullable
                                                   VkAttachmentReference2 value)

Unsafe version of pFragmentShadingRateAttachment.

nshadingRateAttachmentTexelSize

public static void nshadingRateAttachmentTexelSize(long struct,
                                                   VkExtent2D value)

Unsafe version of shadingRateAttachmentTexelSize.

Class VkFragmentShadingRateAttachmentInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, PFRAGMENTSHADINGRATEATTACHMENT, SHADINGRATEATTACHMENTTEXELSIZE

Constructor Detail

VkFragmentShadingRateAttachmentInfoKHR

Method Detail

sizeof

sType

pNext

pFragmentShadingRateAttachment

shadingRateAttachmentTexelSize

sType

sType$Default

pNext

pFragmentShadingRateAttachment

shadingRateAttachmentTexelSize

shadingRateAttachmentTexelSize

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

npFragmentShadingRateAttachment

nshadingRateAttachmentTexelSize

nsType

npNext

npFragmentShadingRateAttachment

nshadingRateAttachmentTexelSize