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

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

public class VkAttachmentDescription
extends Struct

Khronos Reference Page
Vulkan Specification

Describes properties of an attachment.

Valid Usage

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

Member documentation

flags – a bitfield of VkAttachmentDescriptionFlagBits describing additional properties of the attachment. One or more of:
ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT
format – a VkFormat value specifying the format of the image that will be used for the attachment
samples – the number of samples of the image as defined in VkSampleCountFlagBits. One of:
SAMPLE_COUNT_16_BIT SAMPLE_COUNT_1_BIT SAMPLE_COUNT_2_BIT SAMPLE_COUNT_32_BIT
SAMPLE_COUNT_4_BIT SAMPLE_COUNT_64_BIT SAMPLE_COUNT_8_BIT
loadOp – specifies how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used. One of:
ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_DONT_CARE ATTACHMENT_LOAD_OP_LOAD
storeOp – specifies how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used. One of:
ATTACHMENT_STORE_OP_DONT_CARE ATTACHMENT_STORE_OP_STORE
stencilLoadOp – specifies how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used, and must be one of the same values allowed for loadOp
stencilStoreOp – specifies how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used, and must be one of the same values allowed for storeOp

initialLayout – the layout the attachment image subresource will be in when a render pass instance begins. 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`

finalLayout – the layout the attachment image subresource will be transitioned to when a render pass instance ends. During a render pass instance, an attachment can use a different layout in each subpass, if desired.

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

static class VkAttachmentDescription.Buffer
An array of VkAttachmentDescription 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
`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 and 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, MemoryStack stack)` Returns a new `VkAttachmentDescription.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescription`	`callocStack(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 or `null` if the address is `NULL`.
`static VkAttachmentDescription.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentDescription.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkAttachmentDescription.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentDescription`	`mallocStack(MemoryStack stack)` Returns a new `VkAttachmentDescription` instance allocated on the specified `MemoryStack`.
`VkAttachmentDescription`	`nset(long struct)` Unsafe version of `set`.
`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()` Returns the `sizeof(struct)`.
`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 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
  - 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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.
  - nset
```
public VkAttachmentDescription nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                         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,
                                                         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

`SAMPLE_COUNT_16_BIT`	`SAMPLE_COUNT_1_BIT`	`SAMPLE_COUNT_2_BIT`	`SAMPLE_COUNT_32_BIT`
`SAMPLE_COUNT_4_BIT`	`SAMPLE_COUNT_64_BIT`	`SAMPLE_COUNT_8_BIT`

Class VkAttachmentDescription

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

VkAttachmentDescription

Method Detail

sizeof

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack