VkClearValue (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

This union is used where part of the API requires either color or depth/stencil clear values, depending on the attachment, and defines the initial clear values in the VkRenderPassBeginInfo structure.

See Also

VkClearAttachment, VkClearColorValue, VkClearDepthStencilValue, VkRenderPassBeginInfo

Member documentation
- color – specifies the color image clear values to use when clearing a color image or attachment.
- depthStencil – specifies 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
  org.lwjgl.system.Pointer.Default

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

Field Summary

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

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

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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearValue.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearValue`	`callocStack(org.lwjgl.system.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(java.util.function.Consumer<VkClearColorValue> consumer)` Passes the `color` field to the specified `Consumer`.
`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.
`static VkClearValue.Buffer`	`create(long address, int capacity)` Create a `VkClearValue.Buffer` instance at the specified memory.
`static VkClearValue`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkClearValue.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkClearDepthStencilValue`	`depthStencil()` Returns a `VkClearDepthStencilValue` view of the `depthStencil` field.
`VkClearValue`	`depthStencil(java.util.function.Consumer<VkClearDepthStencilValue> consumer)` Passes the `depthStencil` field to the specified `Consumer`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearValue.Buffer` instance allocated on the specified `MemoryStack`.
`static VkClearValue`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearValue` instance allocated on the specified `MemoryStack`.
`static VkClearColorValue`	`ncolor(long struct)` Unsafe version of `color()`.
`static void`	`ncolor(long struct, VkClearColorValue value)` Unsafe version of `color`.
`static VkClearDepthStencilValue`	`ndepthStencil(long struct)` Unsafe version of `depthStencil()`.
`static void`	`ndepthStencil(long struct, VkClearDepthStencilValue value)` Unsafe version of `depthStencil`.
`VkClearValue`	`set(VkClearValue 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.
  - COLOR
```
public static final int COLOR
```
    The struct member offsets.
  - DEPTHSTENCIL
```
public static final int DEPTHSTENCIL
```
    The struct member offsets.
- 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - color
```
public VkClearValue color(java.util.function.Consumer<VkClearColorValue> consumer)
```
    Passes the color field to the specified Consumer.
  - depthStencil
```
public VkClearValue depthStencil(VkClearDepthStencilValue value)
```
    Copies the specified VkClearDepthStencilValue to the depthStencil field.
  - depthStencil
```
public VkClearValue depthStencil(java.util.function.Consumer<VkClearDepthStencilValue> consumer)
```
    Passes the depthStencil field to the specified Consumer.
  - 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.
  - createSafe
```
@Nullable
public static VkClearValue createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkClearValue.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                              org.lwjgl.system.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,
                                              org.lwjgl.system.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
  - ncolor
```
public static VkClearColorValue ncolor(long struct)
```
    Unsafe version of color().
  - ndepthStencil
```
public static VkClearDepthStencilValue ndepthStencil(long struct)
```
    Unsafe version of depthStencil().
  - ncolor
```
public static void ncolor(long struct,
                          VkClearColorValue value)
```
    Unsafe version of color.
  - ndepthStencil
```
public static void ndepthStencil(long struct,
                                 VkClearDepthStencilValue value)
```
    Unsafe version of depthStencil.

Class VkClearValue

Description

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

COLOR

DEPTHSTENCIL

Constructor Detail

VkClearValue

Method Detail

sizeof

color

depthStencil

color

color

depthStencil

depthStencil

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncolor

ndepthStencil

ncolor

ndepthStencil