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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAttachmentDescription
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an attachment description.
Description

If the attachment uses a color format, then loadOp and storeOp are used, and stencilLoadOp and stencilStoreOp are ignored. If the format has depth and/or stencil components, loadOp and storeOp apply only to the depth data, while stencilLoadOp and stencilStoreOp define how the stencil data is handled. loadOp and stencilLoadOp define the load operations that execute as part of the first subpass that uses the attachment. storeOp and stencilStoreOp define the store operations that execute as part of the last subpass that uses the attachment.

The load operation for each sample in an attachment happens-before any recorded command which accesses the sample in the first subpass where the attachment is used. Load operations for attachments with a depth/stencil format execute in the PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT pipeline stage. Load operations for attachments with a color format execute in the PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage.

The store operation for each sample in an attachment happens-after any recorded command which accesses the sample in the last subpass where the attachment is used. Store operations for attachments with a depth/stencil format execute in the PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT pipeline stage. Store operations for attachments with a color format execute in the PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage.

If an attachment is not used by any subpass, then loadOp, storeOp, stencilStoreOp, and stencilLoadOp are ignored, and the attachment's memory contents will not be modified by execution of a render pass instance.

The load and store operations apply on the first and last use of each view in the render pass, respectively. If a view index of an attachment is not included in the view mask in any subpass that uses it, then the load and store operations are ignored, and the attachment's memory contents will not be modified by execution of a render pass instance.

During a render pass instance, input/color attachments with color formats that have a component size of 8, 16, or 32 bits must be represented in the attachment's format throughout the instance. Attachments with other floating- or fixed-point color formats, or with depth components may be represented in a format with a precision higher than the attachment format, but must be represented with the same range. When such a component is loaded via the loadOp, it will be converted into an implementation-dependent format used by the render pass. Such components must be converted from the render pass format, to the format of the attachment, before they are resolved or stored at the end of a render pass instance via storeOp. Conversions occur as described in Numeric Representation and Computation and Fixed-Point Data Conversions.

If flags includes ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT, then the attachment is treated as if it shares physical memory with another attachment in the same render pass. This information limits the ability of the implementation to reorder certain operations (like layout transitions and the loadOp) such that it is not improperly reordered against other uses of the same physical memory via a different attachment. This is described in more detail below.

Valid Usage
- finalLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
- flags must be a valid combination of VkAttachmentDescriptionFlagBits values
- format must be a valid VkFormat value
- samples must be a valid VkSampleCountFlagBits value
- loadOp must be a valid VkAttachmentLoadOp value
- storeOp must be a valid VkAttachmentStoreOp value
- stencilLoadOp must be a valid VkAttachmentLoadOp value
- stencilStoreOp must be a valid VkAttachmentStoreOp value
- initialLayout must be a valid VkImageLayout value
- finalLayout must be a valid VkImageLayout value
See Also

VkRenderPassCreateInfo

Member documentation
- flags – a bitmask of VkAttachmentDescriptionFlagBits specifying additional properties of the attachment.
- format – a VkFormat value specifying the format of the image view that will be used for the attachment.
- samples – the number of samples of the image as defined in VkSampleCountFlagBits.
- loadOp – a VkAttachmentLoadOp value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.
- storeOp – a VkAttachmentStoreOp value specifying how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.
- stencilLoadOp – a VkAttachmentLoadOp value specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.
- stencilStoreOp – a VkAttachmentStoreOp value specifying how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used.
- initialLayout – the layout the attachment image subresource will be in when a render pass instance begins.
- finalLayout – the layout the attachment image subresource will be transitioned to when a render pass instance ends.
Layout
```
 struct VkAttachmentDescription {
     VkAttachmentDescriptionFlags flags;
     VkFormat format;
     VkSampleCountFlagBits samples;
     VkAttachmentLoadOp loadOp;
     VkAttachmentStoreOp storeOp;
     VkAttachmentLoadOp stencilLoadOp;
     VkAttachmentStoreOp stencilStoreOp;
     VkImageLayout initialLayout;
     VkImageLayout finalLayout;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FINALLAYOUT FLAGS FORMAT INITIALLAYOUT LOADOP SAMPLES`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STENCILLOADOP STENCILSTOREOP STOREOP`	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
`VkAttachmentDescription(java.nio.ByteBuffer container)`	Creates a `VkAttachmentDescription` 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 VkAttachmentDescription`	`calloc()`	Returns a new `VkAttachmentDescription` instance allocated with `memCalloc`.
`static VkAttachmentDescription.Buffer`	`calloc(int capacity)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentDescription`	`callocStack()`	Returns a new `VkAttachmentDescription` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescription.Buffer`	`callocStack(int capacity)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescription.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescription`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescription` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescription`	`create()`	Returns a new `VkAttachmentDescription` instance allocated with `BufferUtils`.
`static VkAttachmentDescription.Buffer`	`create(int capacity)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentDescription`	`create(long address)`	Returns a new `VkAttachmentDescription` instance for the specified memory address.
`static VkAttachmentDescription.Buffer`	`create(long address, int capacity)`	Create a `VkAttachmentDescription.Buffer` instance at the specified memory.
`static VkAttachmentDescription`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentDescription.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`finalLayout()`	Returns the value of the `finalLayout` field.
`VkAttachmentDescription`	`finalLayout(int value)`	Sets the specified value to the `finalLayout` field.
`int`	`flags()`	Returns the value of the `flags` field.
`VkAttachmentDescription`	`flags(int value)`	Sets the specified value to the `flags` field.
`int`	`format()`	Returns the value of the `format` field.
`VkAttachmentDescription`	`format(int value)`	Sets the specified value to the `format` field.
`int`	`initialLayout()`	Returns the value of the `initialLayout` field.
`VkAttachmentDescription`	`initialLayout(int value)`	Sets the specified value to the `initialLayout` field.
`int`	`loadOp()`	Returns the value of the `loadOp` field.
`VkAttachmentDescription`	`loadOp(int value)`	Sets the specified value to the `loadOp` field.
`static VkAttachmentDescription`	`malloc()`	Returns a new `VkAttachmentDescription` instance allocated with `memAlloc`.
`static VkAttachmentDescription.Buffer`	`malloc(int capacity)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentDescription`	`mallocStack()`	Returns a new `VkAttachmentDescription` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentDescription.Buffer`	`mallocStack(int capacity)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentDescription.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescription.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentDescription`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescription` instance allocated on the specified `MemoryStack`.
`static int`	`nfinalLayout(long struct)`	Unsafe version of `finalLayout()`.
`static void`	`nfinalLayout(long struct, int value)`	Unsafe version of `finalLayout`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static int`	`nformat(long struct)`	Unsafe version of `format()`.
`static void`	`nformat(long struct, int value)`	Unsafe version of `format`.
`static int`	`ninitialLayout(long struct)`	Unsafe version of `initialLayout()`.
`static void`	`ninitialLayout(long struct, int value)`	Unsafe version of `initialLayout`.
`static int`	`nloadOp(long struct)`	Unsafe version of `loadOp()`.
`static void`	`nloadOp(long struct, int value)`	Unsafe version of `loadOp`.
`static int`	`nsamples(long struct)`	Unsafe version of `samples()`.
`static void`	`nsamples(long struct, int value)`	Unsafe version of `samples`.
`static int`	`nstencilLoadOp(long struct)`	Unsafe version of `stencilLoadOp()`.
`static void`	`nstencilLoadOp(long struct, int value)`	Unsafe version of `stencilLoadOp`.
`static int`	`nstencilStoreOp(long struct)`	Unsafe version of `stencilStoreOp()`.
`static void`	`nstencilStoreOp(long struct, int value)`	Unsafe version of `stencilStoreOp`.
`static int`	`nstoreOp(long struct)`	Unsafe version of `storeOp()`.
`static void`	`nstoreOp(long struct, int value)`	Unsafe version of `storeOp`.
`int`	`samples()`	Returns the value of the `samples` field.
`VkAttachmentDescription`	`samples(int value)`	Sets the specified value to the `samples` field.
`VkAttachmentDescription`	`set(int flags, int format, int samples, int loadOp, int storeOp, int stencilLoadOp, int stencilStoreOp, int initialLayout, int finalLayout)`	Initializes this struct with the specified values.
`VkAttachmentDescription`	`set(VkAttachmentDescription src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilLoadOp()`	Returns the value of the `stencilLoadOp` field.
`VkAttachmentDescription`	`stencilLoadOp(int value)`	Sets the specified value to the `stencilLoadOp` field.
`int`	`stencilStoreOp()`	Returns the value of the `stencilStoreOp` field.
`VkAttachmentDescription`	`stencilStoreOp(int value)`	Sets the specified value to the `stencilStoreOp` field.
`int`	`storeOp()`	Returns the value of the `storeOp` field.
`VkAttachmentDescription`	`storeOp(int value)`	Sets the specified value to the `storeOp` 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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - FLAGS, FORMAT, SAMPLES, LOADOP, STOREOP, STENCILLOADOP, STENCILSTOREOP, INITIALLAYOUT, FINALLAYOUT
    
    The struct member offsets.
- Constructor Detail
  - VkAttachmentDescription
```
public VkAttachmentDescription(java.nio.ByteBuffer container)
```
    Creates a VkAttachmentDescription 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
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - format
```
public int format()
```
    Returns the value of the format field.
  - samples
```
public int samples()
```
    Returns the value of the samples field.
  - loadOp
```
public int loadOp()
```
    Returns the value of the loadOp field.
  - storeOp
```
public int storeOp()
```
    Returns the value of the storeOp field.
  - stencilLoadOp
```
public int stencilLoadOp()
```
    Returns the value of the stencilLoadOp field.
  - stencilStoreOp
```
public int stencilStoreOp()
```
    Returns the value of the stencilStoreOp field.
  - initialLayout
```
public int initialLayout()
```
    Returns the value of the initialLayout field.
  - finalLayout
```
public int finalLayout()
```
    Returns the value of the finalLayout field.
  - flags
```
public VkAttachmentDescription flags(int value)
```
    Sets the specified value to the flags field.
  - format
```
public VkAttachmentDescription format(int value)
```
    Sets the specified value to the format field.
  - samples
```
public VkAttachmentDescription samples(int value)
```
    Sets the specified value to the samples field.
  - loadOp
```
public VkAttachmentDescription loadOp(int value)
```
    Sets the specified value to the loadOp field.
  - storeOp
```
public VkAttachmentDescription storeOp(int value)
```
    Sets the specified value to the storeOp field.
  - stencilLoadOp
```
public VkAttachmentDescription stencilLoadOp(int value)
```
    Sets the specified value to the stencilLoadOp field.
  - stencilStoreOp
```
public VkAttachmentDescription stencilStoreOp(int value)
```
    Sets the specified value to the stencilStoreOp field.
  - initialLayout
```
public VkAttachmentDescription initialLayout(int value)
```
    Sets the specified value to the initialLayout field.
  - finalLayout
```
public VkAttachmentDescription finalLayout(int value)
```
    Sets the specified value to the finalLayout field.
  - set
```
public VkAttachmentDescription set(int flags,
                                   int format,
                                   int samples,
                                   int loadOp,
                                   int storeOp,
                                   int stencilLoadOp,
                                   int stencilStoreOp,
                                   int initialLayout,
                                   int finalLayout)
```
    Initializes this struct with the specified values.
  - set
```
public VkAttachmentDescription set(VkAttachmentDescription src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAttachmentDescription malloc()
```
    Returns a new VkAttachmentDescription instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentDescription calloc()
```
    Returns a new VkAttachmentDescription instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentDescription create()
```
    Returns a new VkAttachmentDescription instance allocated with BufferUtils.
  - create
```
public static VkAttachmentDescription create(long address)
```
    Returns a new VkAttachmentDescription instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentDescription createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentDescription.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentDescription.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescription.Buffer create(int capacity)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescription.Buffer create(long address,
                                                    int capacity)
```
    Create a VkAttachmentDescription.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentDescription.Buffer createSafe(long address,
                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkAttachmentDescription mallocStack()
```
    Returns a new VkAttachmentDescription instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAttachmentDescription callocStack()
```
    Returns a new VkAttachmentDescription instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAttachmentDescription mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescription instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAttachmentDescription callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkAttachmentDescription.Buffer mallocStack(int capacity)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentDescription.Buffer callocStack(int capacity)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkAttachmentDescription.Buffer mallocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescription.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentDescription.Buffer callocStack(int capacity,
                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescription.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
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nformat
```
public static int nformat(long struct)
```
    Unsafe version of format().
  - nsamples
```
public static int nsamples(long struct)
```
    Unsafe version of samples().
  - nloadOp
```
public static int nloadOp(long struct)
```
    Unsafe version of loadOp().
  - nstoreOp
```
public static int nstoreOp(long struct)
```
    Unsafe version of storeOp().
  - nstencilLoadOp
```
public static int nstencilLoadOp(long struct)
```
    Unsafe version of stencilLoadOp().
  - nstencilStoreOp
```
public static int nstencilStoreOp(long struct)
```
    Unsafe version of stencilStoreOp().
  - ninitialLayout
```
public static int ninitialLayout(long struct)
```
    Unsafe version of initialLayout().
  - nfinalLayout
```
public static int nfinalLayout(long struct)
```
    Unsafe version of finalLayout().
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nformat
```
public static void nformat(long struct,
                           int value)
```
    Unsafe version of format.
  - nsamples
```
public static void nsamples(long struct,
                            int value)
```
    Unsafe version of samples.
  - nloadOp
```
public static void nloadOp(long struct,
                           int value)
```
    Unsafe version of loadOp.
  - nstoreOp
```
public static void nstoreOp(long struct,
                            int value)
```
    Unsafe version of storeOp.
  - nstencilLoadOp
```
public static void nstencilLoadOp(long struct,
                                  int value)
```
    Unsafe version of stencilLoadOp.
  - nstencilStoreOp
```
public static void nstencilStoreOp(long struct,
                                   int value)
```
    Unsafe version of stencilStoreOp.
  - ninitialLayout
```
public static void ninitialLayout(long struct,
                                  int value)
```
    Unsafe version of initialLayout.
  - nfinalLayout
```
public static void nfinalLayout(long struct,
                                int value)
```
    Unsafe version of finalLayout.

Class VkAttachmentDescription

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 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

FLAGS, FORMAT, SAMPLES, LOADOP, STOREOP, STENCILLOADOP, STENCILSTOREOP, INITIALLAYOUT, FINALLAYOUT

Constructor Detail

VkAttachmentDescription

Method Detail

sizeof

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nflags

nformat

nsamples

nloadOp

nstoreOp

nstencilLoadOp

nstencilStoreOp

ninitialLayout

nfinalLayout

nflags

nformat

nsamples

nloadOp

nstoreOp

nstencilLoadOp

nstencilStoreOp

ninitialLayout