VkAttachmentReference (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAttachmentReference
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an attachment reference.
Valid Usage
- If attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, IMAGE_LAYOUT_PRESENT_SRC_KHR, 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
Valid Usage (Implicit)
- layout must be a valid VkImageLayout value
See Also

VkRenderPassFragmentDensityMapCreateInfoEXT, VkSubpassDescription

Member documentation
- 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.
Layout
```
 struct VkAttachmentReference {
     uint32_t attachment;
     VkImageLayout layout;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkAttachmentReference.Buffer
An array of VkAttachmentReference 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`	`VkAttachmentReference.Buffer` An array of `VkAttachmentReference` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ATTACHMENT` The struct member offsets.
`static int`	`LAYOUT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkAttachmentReference(java.nio.ByteBuffer container)` Creates a `VkAttachmentReference` 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`	`attachment()` Returns the value of the `attachment` field.
`VkAttachmentReference`	`attachment(int value)` Sets the specified value to the `attachment` field.
`static VkAttachmentReference`	`calloc()` Returns a new `VkAttachmentReference` instance allocated with `memCalloc`.
`static VkAttachmentReference.Buffer`	`calloc(int capacity)` Returns a new `VkAttachmentReference.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentReference`	`callocStack()` Returns a new `VkAttachmentReference` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference.Buffer`	`callocStack(int capacity)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference`	`create()` Returns a new `VkAttachmentReference` instance allocated with `BufferUtils`.
`static VkAttachmentReference.Buffer`	`create(int capacity)` Returns a new `VkAttachmentReference.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentReference`	`create(long address)` Returns a new `VkAttachmentReference` instance for the specified memory address.
`static VkAttachmentReference.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentReference.Buffer` instance at the specified memory.
`static VkAttachmentReference`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentReference.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`layout()` Returns the value of the `layout` field.
`VkAttachmentReference`	`layout(int value)` Sets the specified value to the `layout` field.
`static VkAttachmentReference`	`malloc()` Returns a new `VkAttachmentReference` instance allocated with `memAlloc`.
`static VkAttachmentReference.Buffer`	`malloc(int capacity)` Returns a new `VkAttachmentReference.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentReference`	`mallocStack()` Returns a new `VkAttachmentReference` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentReference.Buffer`	`mallocStack(int capacity)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentReference.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentReference`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentReference` instance allocated on the specified `MemoryStack`.
`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`.
`VkAttachmentReference`	`set(int attachment, int layout)` Initializes this struct with the specified values.
`VkAttachmentReference`	`set(VkAttachmentReference src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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

Class VkAttachmentReference

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

ATTACHMENT

LAYOUT

Constructor Detail

VkAttachmentReference

Method Detail

sizeof

attachment

layout

attachment

layout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nattachment

nlayout

nattachment

nlayout