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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkAttachmentReference2KHR
```
public class VkAttachmentReference2
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an attachment reference.
Description

Parameters defined by this structure with the same name as those in VkAttachmentReference have the identical effect to those parameters.

aspectMask is ignored when this structure is used to describe anything other than an input attachment reference.

If the separateDepthStencilLayouts feature is enabled, and attachment has a depth/stencil format, layout can be set to a layout that only specifies the layout of the depth aspect.

If layout only specifies the layout of the depth aspect of the attachment, the layout of the stencil aspect is specified by the stencilLayout member of a VkAttachmentReferenceStencilLayout structure included in the pNext chain. Otherwise, layout describes the layout for all relevant image aspects.

Valid Usage
- If attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, or IMAGE_LAYOUT_PRESENT_SRC_KHR
- If the separateDepthStencilLayouts feature is not enabled, and attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
- If attachment is not ATTACHMENT_UNUSED, and the format of the referenced attachment is a color format, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
- If attachment is not ATTACHMENT_UNUSED, and the format of the referenced attachment is a depth/stencil format which includes both depth and stencil aspects, and layout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain must include a VkAttachmentReferenceStencilLayout structure
- If attachment is not ATTACHMENT_UNUSED, and the format of the referenced attachment is a depth/stencil format which includes only the depth aspect, layout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
- If attachment is not ATTACHMENT_UNUSED, and the format of the referenced attachment is a depth/stencil format which includes only the stencil aspect, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2
- pNext must be NULL or a pointer to a valid instance of VkAttachmentReferenceStencilLayout
- The sType value of each struct in the pNext chain must be unique
- layout must be a valid VkImageLayout value
See Also

VkFragmentShadingRateAttachmentInfoKHR, VkSubpassDescription2, VkSubpassDescriptionDepthStencilResolve

Layout
```
 struct VkAttachmentReference2 {
     VkStructureType sType();
     void const * pNext();
     uint32_t attachment();
     VkImageLayout layout();
     VkImageAspectFlags aspectMask();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkAttachmentReference2.Buffer
An array of VkAttachmentReference2 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`	`ASPECTMASK ATTACHMENT LAYOUT PNEXT`	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
`VkAttachmentReference2(java.nio.ByteBuffer container)`	Creates a `VkAttachmentReference2` 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
`int`	`aspectMask()`	a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.
`VkAttachmentReference2`	`aspectMask(int value)`	Sets the specified value to the `aspectMask()` field.
`int`	`attachment()`	either an integer value identifying an attachment at the corresponding index in `VkRenderPassCreateInfo2::pAttachments`, or `ATTACHMENT_UNUSED` to signify that this attachment is not used.
`VkAttachmentReference2`	`attachment(int value)`	Sets the specified value to the `attachment()` field.
`static VkAttachmentReference2`	`calloc()`	Returns a new `VkAttachmentReference2` instance allocated with `memCalloc`.
`static VkAttachmentReference2.Buffer`	`calloc(int capacity)`	Returns a new `VkAttachmentReference2.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentReference2.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentReference2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentReference2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2`	`create()`	Returns a new `VkAttachmentReference2` instance allocated with `BufferUtils`.
`static VkAttachmentReference2.Buffer`	`create(int capacity)`	Returns a new `VkAttachmentReference2.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentReference2`	`create(long address)`	Returns a new `VkAttachmentReference2` instance for the specified memory address.
`static VkAttachmentReference2.Buffer`	`create(long address, int capacity)`	Create a `VkAttachmentReference2.Buffer` instance at the specified memory.
`static VkAttachmentReference2`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentReference2.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`layout()`	a `VkImageLayout` value specifying the layout the attachment uses during the subpass.
`VkAttachmentReference2`	`layout(int value)`	Sets the specified value to the `layout()` field.
`static VkAttachmentReference2`	`malloc()`	Returns a new `VkAttachmentReference2` instance allocated with `memAlloc`.
`static VkAttachmentReference2.Buffer`	`malloc(int capacity)`	Returns a new `VkAttachmentReference2.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentReference2.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentReference2.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentReference2`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentReference2` instance allocated on the specified `MemoryStack`.
`static int`	`naspectMask(long struct)`	Unsafe version of `aspectMask()`.
`static void`	`naspectMask(long struct, int value)`	Unsafe version of `aspectMask`.
`static int`	`nattachment(long struct)`	Unsafe version of `attachment()`.
`static void`	`nattachment(long struct, int value)`	Unsafe version of `attachment`.
`static int`	`nlayout(long struct)`	Unsafe version of `layout()`.
`static void`	`nlayout(long struct, int value)`	Unsafe version of `layout`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`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.
`VkAttachmentReference2`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkAttachmentReference2`	`pNext(VkAttachmentReferenceStencilLayout value)`	Prepends the specified `VkAttachmentReferenceStencilLayout` value to the `pNext` chain.
`VkAttachmentReference2`	`pNext(VkAttachmentReferenceStencilLayoutKHR value)`	Prepends the specified `VkAttachmentReferenceStencilLayoutKHR` value to the `pNext` chain.
`VkAttachmentReference2`	`set(int sType, long pNext, int attachment, int layout, int aspectMask)`	Initializes this struct with the specified values.
`VkAttachmentReference2`	`set(VkAttachmentReference2 src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkAttachmentReference2`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkAttachmentReference2`	`sType$Default()`	Sets the `STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2` 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, ATTACHMENT, LAYOUT, ASPECTMASK
    
    The struct member offsets.
- Constructor Detail
  - VkAttachmentReference2
```
public VkAttachmentReference2(java.nio.ByteBuffer container)
```
    Creates a VkAttachmentReference2 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.
  - attachment
```
public int attachment()
```
    either an integer value identifying an attachment at the corresponding index in VkRenderPassCreateInfo2::pAttachments, or ATTACHMENT_UNUSED to signify that this attachment is not used.
  - layout
```
public int layout()
```
    a VkImageLayout value specifying the layout the attachment uses during the subpass.
  - aspectMask
```
public int aspectMask()
```
    a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.
  - sType
```
public VkAttachmentReference2 sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkAttachmentReference2 sType$Default()
```
    Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType() field.
  - pNext
```
public VkAttachmentReference2 pNext(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayout value)
```
    Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.
  - pNext
```
public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayoutKHR value)
```
    Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.
  - attachment
```
public VkAttachmentReference2 attachment(int value)
```
    Sets the specified value to the attachment() field.
  - layout
```
public VkAttachmentReference2 layout(int value)
```
    Sets the specified value to the layout() field.
  - aspectMask
```
public VkAttachmentReference2 aspectMask(int value)
```
    Sets the specified value to the aspectMask() field.
  - set
```
public VkAttachmentReference2 set(int sType,
                                  long pNext,
                                  int attachment,
                                  int layout,
                                  int aspectMask)
```
    Initializes this struct with the specified values.
  - set
```
public VkAttachmentReference2 set(VkAttachmentReference2 src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAttachmentReference2 malloc()
```
    Returns a new VkAttachmentReference2 instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentReference2 calloc()
```
    Returns a new VkAttachmentReference2 instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentReference2 create()
```
    Returns a new VkAttachmentReference2 instance allocated with BufferUtils.
  - create
```
public static VkAttachmentReference2 create(long address)
```
    Returns a new VkAttachmentReference2 instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentReference2 createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentReference2.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentReference2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentReference2.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentReference2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentReference2.Buffer create(int capacity)
```
    Returns a new VkAttachmentReference2.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentReference2.Buffer create(long address,
                                                   int capacity)
```
    Create a VkAttachmentReference2.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentReference2.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentReference2 malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkAttachmentReference2 calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkAttachmentReference2.Buffer malloc(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentReference2.Buffer calloc(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2.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().
  - nattachment
```
public static int nattachment(long struct)
```
    Unsafe version of attachment().
  - nlayout
```
public static int nlayout(long struct)
```
    Unsafe version of layout().
  - naspectMask
```
public static int naspectMask(long struct)
```
    Unsafe version of aspectMask().
  - 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.
  - nattachment
```
public static void nattachment(long struct,
                               int value)
```
    Unsafe version of attachment.
  - nlayout
```
public static void nlayout(long struct,
                           int value)
```
    Unsafe version of layout.
  - naspectMask
```
public static void naspectMask(long struct,
                               int value)
```
    Unsafe version of aspectMask.

Class VkAttachmentReference2

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, ATTACHMENT, LAYOUT, ASPECTMASK

Constructor Detail

VkAttachmentReference2

Method Detail

sizeof

sType

pNext

attachment

layout

aspectMask

sType

sType$Default

pNext

pNext

pNext

attachment

layout

aspectMask

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nattachment

nlayout

naspectMask

nsType

npNext

nattachment

nlayout

naspectMask