VkClearAttachment (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkClearAttachment
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a clear attachment.
Description

No memory barriers are needed between vkCmdClearAttachments and preceding or subsequent draw or attachment clear commands in the same subpass.

The vkCmdClearAttachments command is not affected by the bound pipeline state.

Attachments can also be cleared at the beginning of a render pass instance by setting loadOp (or stencilLoadOp) of VkAttachmentDescription to ATTACHMENT_LOAD_OP_CLEAR, as described for CreateRenderPass.

Valid Usage
- 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
- aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i.
- clearValue must be a valid VkClearValue union
Valid Usage (Implicit)
- aspectMask must be a valid combination of VkImageAspectFlagBits values
- aspectMask must not be 0
See Also

VkClearValue, CmdClearAttachments

Member documentation
- aspectMask – a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared.
- colorAttachment – 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, as described in Clear Values below.
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
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkClearAttachment.Buffer` An array of `VkClearAttachment` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ASPECTMASK` The struct member offsets.
`static int`	`CLEARVALUE` The struct member offsets.
`static int`	`COLORATTACHMENT` 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

VkClearAttachment(java.nio.ByteBuffer container)
Creates a VkClearAttachment instance at the current position of the specified ByteBuffer container.

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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearAttachment`	`callocStack(org.lwjgl.system.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(java.util.function.Consumer<VkClearValue> consumer)` Passes the `clearValue` field to the specified `Consumer`.
`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.
`static VkClearAttachment.Buffer`	`create(long address, int capacity)` Create a `VkClearAttachment.Buffer` instance at the specified memory.
`static VkClearAttachment`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkClearAttachment.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack`.
`static VkClearAttachment`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack`.
`static int`	`naspectMask(long struct)` Unsafe version of `aspectMask()`.
`static void`	`naspectMask(long struct, int value)` Unsafe version of `aspectMask`.
`static VkClearValue`	`nclearValue(long struct)` Unsafe version of `clearValue()`.
`static void`	`nclearValue(long struct, VkClearValue value)` Unsafe version of `clearValue`.
`static int`	`ncolorAttachment(long struct)` Unsafe version of `colorAttachment()`.
`static void`	`ncolorAttachment(long struct, int value)` Unsafe version of `colorAttachment`.
`VkClearAttachment`	`set(int aspectMask, int colorAttachment, VkClearValue clearValue)` Initializes this struct with the specified values.
`VkClearAttachment`	`set(VkClearAttachment 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.
  - ASPECTMASK
```
public static final int ASPECTMASK
```
    The struct member offsets.
  - COLORATTACHMENT
```
public static final int COLORATTACHMENT
```
    The struct member offsets.
  - CLEARVALUE
```
public static final int CLEARVALUE
```
    The struct member offsets.
- 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - clearValue
```
public VkClearAttachment clearValue(java.util.function.Consumer<VkClearValue> consumer)
```
    Passes the clearValue field to the specified Consumer.
  - set
```
public VkClearAttachment set(int aspectMask,
                             int colorAttachment,
                             VkClearValue clearValue)
```
    Initializes this struct with the specified values.
  - 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.
  - createSafe
```
@Nullable
public static VkClearAttachment createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkClearAttachment.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                   org.lwjgl.system.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,
                                                   org.lwjgl.system.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
  - naspectMask
```
public static int naspectMask(long struct)
```
    Unsafe version of aspectMask().
  - ncolorAttachment
```
public static int ncolorAttachment(long struct)
```
    Unsafe version of colorAttachment().
  - nclearValue
```
public static VkClearValue nclearValue(long struct)
```
    Unsafe version of clearValue().
  - naspectMask
```
public static void naspectMask(long struct,
                               int value)
```
    Unsafe version of aspectMask.
  - ncolorAttachment
```
public static void ncolorAttachment(long struct,
                                    int value)
```
    Unsafe version of colorAttachment.
  - nclearValue
```
public static void nclearValue(long struct,
                               VkClearValue value)
```
    Unsafe version of clearValue.

Class VkClearAttachment

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

ASPECTMASK

COLORATTACHMENT

CLEARVALUE

Constructor Detail

VkClearAttachment

Method Detail

sizeof

aspectMask

colorAttachment

clearValue

aspectMask

colorAttachment

clearValue

clearValue

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

naspectMask

ncolorAttachment

nclearValue

naspectMask

ncolorAttachment

nclearValue