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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkClearValue
extends Struct
```
Khronos Reference Page
Vulkan Specification
Specifies the color or depth/stencil value to clear an attachment to.

Member documentation
- color – the color image clear values to use when clearing a color image or attachment
- depthStencil – the depth and stencil clear values to use when clearing a depth/stencil image or attachment
Layout
```
union VkClearValue {
    VkClearColorValue color;
    VkClearDepthStencilValue depthStencil;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

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

VkClearValue

Method Detail

sizeof

color

depthStencil

color

depthStencil

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack