VkAttachmentReference2KHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAttachmentReference2KHR
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 has the same effect for the described attachment as VkInputAttachmentAspectReference::aspectMask has on each corresponding attachment. It 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 VkAttachmentReferenceStencilLayoutKHR 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 attachment is not ATTACHMENT_UNUSED, and aspectMask does not include IMAGE_ASPECT_STENCIL_BIT or IMAGE_ASPECT_DEPTH_BIT, layout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
- If attachment is not ATTACHMENT_UNUSED, and aspectMask does not include IMAGE_ASPECT_COLOR_BIT, layout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
- If the separateDepthStencilLayouts feature is not enabled, and attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR,
- If attachment is not ATTACHMENT_UNUSED, and aspectMask includes IMAGE_ASPECT_COLOR_BIT, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR,
- If attachment is not ATTACHMENT_UNUSED, and aspectMask includes both IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT, and layout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, the pNext chain must include a VkAttachmentReferenceStencilLayoutKHR structure
- If attachment is not ATTACHMENT_UNUSED, and aspectMask includes only IMAGE_ASPECT_DEPTH_BIT then layout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR
- If attachment is not ATTACHMENT_UNUSED, and aspectMask includes only IMAGE_ASPECT_STENCIL_BIT then layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR
- layout must be a valid VkImageLayout value
See Also

VkSubpassDescription2KHR, VkSubpassDescriptionDepthStencilResolveKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- attachment – either an integer value identifying an attachment at the corresponding index in VkRenderPassCreateInfo::pAttachments, or ATTACHMENT_UNUSED to signify that this attachment is not used.
- layout – a VkImageLayout value specifying the layout the attachment uses during the subpass.
- aspectMask – a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.
Layout
```
 struct VkAttachmentReference2KHR {
     VkStructureType sType;
     void const * pNext;
     uint32_t attachment;
     VkImageLayout layout;
     VkImageAspectFlags aspectMask;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkAttachmentReference2KHR.Buffer` An array of `VkAttachmentReference2KHR` structs.

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`aspectMask()` Returns the value of the `aspectMask` field.
`VkAttachmentReference2KHR`	`aspectMask(int value)` Sets the specified value to the `aspectMask` field.
`int`	`attachment()` Returns the value of the `attachment` field.
`VkAttachmentReference2KHR`	`attachment(int value)` Sets the specified value to the `attachment` field.
`static VkAttachmentReference2KHR`	`calloc()` Returns a new `VkAttachmentReference2KHR` instance allocated with `memCalloc`.
`static VkAttachmentReference2KHR.Buffer`	`calloc(int capacity)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentReference2KHR`	`callocStack()` Returns a new `VkAttachmentReference2KHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2KHR.Buffer`	`callocStack(int capacity)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2KHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2KHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference2KHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference2KHR`	`create()` Returns a new `VkAttachmentReference2KHR` instance allocated with `BufferUtils`.
`static VkAttachmentReference2KHR.Buffer`	`create(int capacity)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentReference2KHR`	`create(long address)` Returns a new `VkAttachmentReference2KHR` instance for the specified memory address.
`static VkAttachmentReference2KHR.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentReference2KHR.Buffer` instance at the specified memory.
`static VkAttachmentReference2KHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentReference2KHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`layout()` Returns the value of the `layout` field.
`VkAttachmentReference2KHR`	`layout(int value)` Sets the specified value to the `layout` field.
`static VkAttachmentReference2KHR`	`malloc()` Returns a new `VkAttachmentReference2KHR` instance allocated with `memAlloc`.
`static VkAttachmentReference2KHR.Buffer`	`malloc(int capacity)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentReference2KHR`	`mallocStack()` Returns a new `VkAttachmentReference2KHR` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentReference2KHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentReference2KHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference2KHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentReference2KHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference2KHR` 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()` Returns the value of the `pNext` field.
`VkAttachmentReference2KHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkAttachmentReference2KHR`	`set(int sType, long pNext, int attachment, int layout, int aspectMask)` Initializes this struct with the specified values.
`VkAttachmentReference2KHR`	`set(VkAttachmentReference2KHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkAttachmentReference2KHR`	`sType(int value)` Sets the specified value to the `sType` field.

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

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 Detail
  - 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.
  - ATTACHMENT
```
public static final int ATTACHMENT
```
    The struct member offsets.
  - LAYOUT
```
public static final int LAYOUT
```
    The struct member offsets.
  - ASPECTMASK
```
public static final int ASPECTMASK
```
    The struct member offsets.
- Constructor Detail
  - VkAttachmentReference2KHR
```
public VkAttachmentReference2KHR(java.nio.ByteBuffer container)
```
    Creates a VkAttachmentReference2KHR 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - attachment
```
public int attachment()
```
    Returns the value of the attachment field.
  - layout
```
public int layout()
```
    Returns the value of the layout field.
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - sType
```
public VkAttachmentReference2KHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkAttachmentReference2KHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - attachment
```
public VkAttachmentReference2KHR attachment(int value)
```
    Sets the specified value to the attachment field.
  - layout
```
public VkAttachmentReference2KHR layout(int value)
```
    Sets the specified value to the layout field.
  - aspectMask
```
public VkAttachmentReference2KHR aspectMask(int value)
```
    Sets the specified value to the aspectMask field.
  - set
```
public VkAttachmentReference2KHR set(int sType,
                                     long pNext,
                                     int attachment,
                                     int layout,
                                     int aspectMask)
```
    Initializes this struct with the specified values.
  - set
```
public VkAttachmentReference2KHR set(VkAttachmentReference2KHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAttachmentReference2KHR malloc()
```
    Returns a new VkAttachmentReference2KHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentReference2KHR calloc()
```
    Returns a new VkAttachmentReference2KHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentReference2KHR create()
```
    Returns a new VkAttachmentReference2KHR instance allocated with BufferUtils.
  - create
```
public static VkAttachmentReference2KHR create(long address)
```
    Returns a new VkAttachmentReference2KHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentReference2KHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentReference2KHR.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentReference2KHR.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentReference2KHR.Buffer create(int capacity)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentReference2KHR.Buffer create(long address,
                                                      int capacity)
```
    Create a VkAttachmentReference2KHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentReference2KHR.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkAttachmentReference2KHR mallocStack()
```
    Returns a new VkAttachmentReference2KHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAttachmentReference2KHR callocStack()
```
    Returns a new VkAttachmentReference2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAttachmentReference2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2KHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAttachmentReference2KHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkAttachmentReference2KHR.Buffer mallocStack(int capacity)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentReference2KHR.Buffer callocStack(int capacity)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkAttachmentReference2KHR.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2KHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentReference2KHR.Buffer callocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentReference2KHR.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 VkAttachmentReference2KHR

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

ATTACHMENT

LAYOUT

ASPECTMASK

Constructor Detail

VkAttachmentReference2KHR

Method Detail

sizeof

sType

pNext

attachment

layout

aspectMask

sType

pNext

attachment

layout

aspectMask

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nattachment

nlayout

naspectMask

nsType

npNext

nattachment

nlayout

naspectMask