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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkClearAttachment
extends Struct
```
Khronos Reference Page
Vulkan Specification
Defines an attachment to clear and the clear values to use.

Valid Usage
- aspectMask must be a valid combination of VkImageAspectFlagBits values
- aspectMask must not be 0
- If aspectMask includes IMAGE_ASPECT_COLOR_BIT, it must not include IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
- aspectMask must not include IMAGE_ASPECT_METADATA_BIT
Member documentation
- aspectMask – a bitmask selecting the color, depth and/or stencil aspects of the attachment to be cleared. One or more of:
  IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_DEPTH_BIT IMAGE_ASPECT_METADATA_BIT
  IMAGE_ASPECT_STENCIL_BIT
- colorAttachment – is only meaningful if IMAGE_ASPECT_COLOR_BIT is set in aspectMask, in which case it is an index to the pColorAttachments array in the VkSubpassDescription structure of the current subpass which selects the color attachment to clear
- clearValue – the color or depth/stencil value to clear the attachment to
Layout
```
struct VkClearAttachment {
    VkImageAspectFlags aspectMask;
    uint32_t colorAttachment;
    VkClearValue clearValue;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkClearAttachment.Buffer
An array of VkClearAttachment 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

VkClearAttachment(java.nio.ByteBuffer container)
Creates a VkClearAttachment 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.
`VkClearAttachment`	`aspectMask(int value)` Sets the specified value to the `aspectMask` field.
`static VkClearAttachment`	`calloc()` Returns a new `VkClearAttachment` instance allocated with `memCalloc`.
`static VkClearAttachment.Buffer`	`calloc(int capacity)` Returns a new `VkClearAttachment.Buffer` instance allocated with `memCalloc`.
`static VkClearAttachment`	`callocStack()` Returns a new `VkClearAttachment` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearAttachment.Buffer`	`callocStack(int capacity)` Returns a new `VkClearAttachment.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearAttachment.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearAttachment`	`callocStack(MemoryStack stack)` Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`VkClearValue`	`clearValue()` Returns a `VkClearValue` view of the `clearValue` field.
`VkClearAttachment`	`clearValue(VkClearValue value)` Copies the specified `VkClearValue` to the `clearValue` field.
`int`	`colorAttachment()` Returns the value of the `colorAttachment` field.
`VkClearAttachment`	`colorAttachment(int value)` Sets the specified value to the `colorAttachment` field.
`static VkClearAttachment`	`create()` Returns a new `VkClearAttachment` instance allocated with `BufferUtils`.
`static VkClearAttachment.Buffer`	`create(int capacity)` Returns a new `VkClearAttachment.Buffer` instance allocated with `BufferUtils`.
`static VkClearAttachment`	`create(long address)` Returns a new `VkClearAttachment` instance for the specified memory address or `null` if the address is `NULL`.
`static VkClearAttachment.Buffer`	`create(long address, int capacity)` Create a `VkClearAttachment.Buffer` instance at the specified memory.
`static VkClearAttachment`	`malloc()` Returns a new `VkClearAttachment` instance allocated with `memAlloc`.
`static VkClearAttachment.Buffer`	`malloc(int capacity)` Returns a new `VkClearAttachment.Buffer` instance allocated with `memAlloc`.
`static VkClearAttachment`	`mallocStack()` Returns a new `VkClearAttachment` instance allocated on the thread-local `MemoryStack`.
`static VkClearAttachment.Buffer`	`mallocStack(int capacity)` Returns a new `VkClearAttachment.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkClearAttachment.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack`.
`static VkClearAttachment`	`mallocStack(MemoryStack stack)` Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack`.
`VkClearAttachment`	`nset(long struct)` Unsafe version of `set`.
`VkClearAttachment`	`set(VkClearAttachment 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
  - VkClearAttachment
```
public VkClearAttachment(java.nio.ByteBuffer container)
```
    Creates a VkClearAttachment 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
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - colorAttachment
```
public int colorAttachment()
```
    Returns the value of the colorAttachment field.
  - clearValue
```
public VkClearValue clearValue()
```
    Returns a VkClearValue view of the clearValue field.
  - aspectMask
```
public VkClearAttachment aspectMask(int value)
```
    Sets the specified value to the aspectMask field.
  - colorAttachment
```
public VkClearAttachment colorAttachment(int value)
```
    Sets the specified value to the colorAttachment field.
  - clearValue
```
public VkClearAttachment clearValue(VkClearValue value)
```
    Copies the specified VkClearValue to the clearValue field.
  - nset
```
public VkClearAttachment nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkClearAttachment set(VkClearAttachment src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkClearAttachment malloc()
```
    Returns a new VkClearAttachment instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkClearAttachment calloc()
```
    Returns a new VkClearAttachment instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkClearAttachment create()
```
    Returns a new VkClearAttachment instance allocated with BufferUtils.
  - create
```
public static VkClearAttachment create(long address)
```
    Returns a new VkClearAttachment instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkClearAttachment.Buffer malloc(int capacity)
```
    Returns a new VkClearAttachment.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkClearAttachment.Buffer calloc(int capacity)
```
    Returns a new VkClearAttachment.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearAttachment.Buffer create(int capacity)
```
    Returns a new VkClearAttachment.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearAttachment.Buffer create(long address,
                                              int capacity)
```
    Create a VkClearAttachment.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkClearAttachment mallocStack()
```
    Returns a new VkClearAttachment instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkClearAttachment callocStack()
```
    Returns a new VkClearAttachment instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkClearAttachment mallocStack(MemoryStack stack)
```
    Returns a new VkClearAttachment instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkClearAttachment callocStack(MemoryStack stack)
```
    Returns a new VkClearAttachment instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkClearAttachment.Buffer mallocStack(int capacity)
```
    Returns a new VkClearAttachment.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearAttachment.Buffer callocStack(int capacity)
```
    Returns a new VkClearAttachment.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkClearAttachment.Buffer mallocStack(int capacity,
                                                   MemoryStack stack)
```
    Returns a new VkClearAttachment.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearAttachment.Buffer callocStack(int capacity,
                                                   MemoryStack stack)
```
    Returns a new VkClearAttachment.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

`IMAGE_ASPECT_COLOR_BIT`	`IMAGE_ASPECT_DEPTH_BIT`	`IMAGE_ASPECT_METADATA_BIT`
`IMAGE_ASPECT_STENCIL_BIT`

Class VkClearAttachment

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

VkClearAttachment

Method Detail

sizeof

aspectMask

colorAttachment

clearValue

aspectMask

colorAttachment

clearValue

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack