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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkAttachmentReference
extends Struct

Khronos Reference Page
Vulkan Specification

Describes a render pass attachment and what layout the attachment image will be in during a subpass.

Valid Usage

layout must be a valid VkImageLayout value

Member documentation

attachment – the index of the attachment of the render pass, and corresponds to the index of the corresponding element in the pAttachments array of the VkRenderPassCreateInfo structure. If any color or depth/stencil attachments are ATTACHMENT_UNUSED, then no writes occur for those attachments.

layout – a VkImageLayout value specifying the layout the attachment uses during the subpass. The implementation will automatically perform layout transitions as needed between subpasses to make each subpass use the requested layouts. One of:

`IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL`	`IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL`
`IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_GENERAL`
`IMAGE_LAYOUT_PREINITIALIZED`	`IMAGE_LAYOUT_PRESENT_SRC_KHR`
`IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL`
`IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL`	`IMAGE_LAYOUT_UNDEFINED`

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
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  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, MemoryStack stack)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentReference`	`callocStack(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 or `null` if the address is `NULL`.
`static VkAttachmentReference.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentReference.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentReference`	`mallocStack(MemoryStack stack)` Returns a new `VkAttachmentReference` instance allocated on the specified `MemoryStack`.
`VkAttachmentReference`	`nset(long struct)` Unsafe version of `set`.
`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()` Returns the `sizeof(struct)`.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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.
  - nset
```
public VkAttachmentReference nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                       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,
                                                       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

Class VkAttachmentReference

Valid Usage

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

Constructor Detail

VkAttachmentReference

Method Detail

sizeof

attachment

layout

attachment

layout

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack