VkClearColorValue (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

The four array elements of the clear color map to R, G, B, and A components of image formats, in order.

If the image has more than one sample, the same value is written to all samples for any pixels being cleared.

See Also

VkClearValue, CmdClearColorImage

Member documentation
- float32[4] – are the color clear values when the format of the image or attachment is one of the formats in the Interpretation of Numeric Format table other than signed integer (SINT) or unsigned integer (UINT). Floating point values are automatically converted to the format of the image, with the clear value being treated as linear if the image is sRGB.
- int32[4] – are the color clear values when the format of the image or attachment is signed integer (SINT). Signed integer values are converted to the format of the image by casting to the smaller type (with negative 32-bit values mapping to negative values in the smaller type). If the integer clear value is not representable in the target type (e.g. would overflow in conversion to that type), the clear value is undefined.
- uint32[4] – are the color clear values when the format of the image or attachment is unsigned integer (UINT). Unsigned integer values are converted to the format of the image by casting to the integer type with fewer bits.
Layout
```
 union VkClearColorValue {
     float float32[4];
     int32_t int32[4];
     uint32_t uint32[4];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkClearColorValue.Buffer
An array of VkClearColorValue 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`	`VkClearColorValue.Buffer` An array of `VkClearColorValue` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLOAT32` The struct member offsets.
`static int`	`INT32` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`UINT32` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`VkClearColorValue(java.nio.ByteBuffer container)` Creates a `VkClearColorValue` 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 VkClearColorValue`	`calloc()` Returns a new `VkClearColorValue` instance allocated with `memCalloc`.
`static VkClearColorValue.Buffer`	`calloc(int capacity)` Returns a new `VkClearColorValue.Buffer` instance allocated with `memCalloc`.
`static VkClearColorValue`	`callocStack()` Returns a new `VkClearColorValue` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearColorValue.Buffer`	`callocStack(int capacity)` Returns a new `VkClearColorValue.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearColorValue.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearColorValue.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearColorValue`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearColorValue` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearColorValue`	`create()` Returns a new `VkClearColorValue` instance allocated with `BufferUtils`.
`static VkClearColorValue.Buffer`	`create(int capacity)` Returns a new `VkClearColorValue.Buffer` instance allocated with `BufferUtils`.
`static VkClearColorValue`	`create(long address)` Returns a new `VkClearColorValue` instance for the specified memory address.
`static VkClearColorValue.Buffer`	`create(long address, int capacity)` Create a `VkClearColorValue.Buffer` instance at the specified memory.
`static VkClearColorValue`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkClearColorValue.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.FloatBuffer`	`float32()` Returns a `FloatBuffer` view of the `float32` field.
`VkClearColorValue`	`float32(java.nio.FloatBuffer value)` Copies the specified `FloatBuffer` to the `float32` field.
`float`	`float32(int index)` Returns the value at the specified index of the `float32` field.
`VkClearColorValue`	`float32(int index, float value)` Sets the specified value at the specified index of the `float32` field.
`java.nio.IntBuffer`	`int32()` Returns a `IntBuffer` view of the `int32` field.
`int`	`int32(int index)` Returns the value at the specified index of the `int32` field.
`VkClearColorValue`	`int32(java.nio.IntBuffer value)` Copies the specified `IntBuffer` to the `int32` field.
`VkClearColorValue`	`int32(int index, int value)` Sets the specified value at the specified index of the `int32` field.
`static VkClearColorValue`	`malloc()` Returns a new `VkClearColorValue` instance allocated with `memAlloc`.
`static VkClearColorValue.Buffer`	`malloc(int capacity)` Returns a new `VkClearColorValue.Buffer` instance allocated with `memAlloc`.
`static VkClearColorValue`	`mallocStack()` Returns a new `VkClearColorValue` instance allocated on the thread-local `MemoryStack`.
`static VkClearColorValue.Buffer`	`mallocStack(int capacity)` Returns a new `VkClearColorValue.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkClearColorValue.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearColorValue.Buffer` instance allocated on the specified `MemoryStack`.
`static VkClearColorValue`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearColorValue` instance allocated on the specified `MemoryStack`.
`static java.nio.FloatBuffer`	`nfloat32(long struct)` Unsafe version of `float32()`.
`static void`	`nfloat32(long struct, java.nio.FloatBuffer value)` Unsafe version of `float32`.
`static float`	`nfloat32(long struct, int index)` Unsafe version of `float32`.
`static void`	`nfloat32(long struct, int index, float value)` Unsafe version of `float32`.
`static java.nio.IntBuffer`	`nint32(long struct)` Unsafe version of `int32()`.
`static int`	`nint32(long struct, int index)` Unsafe version of `int32`.
`static void`	`nint32(long struct, java.nio.IntBuffer value)` Unsafe version of `int32`.
`static void`	`nint32(long struct, int index, int value)` Unsafe version of `int32`.
`static java.nio.IntBuffer`	`nuint32(long struct)` Unsafe version of `uint32()`.
`static int`	`nuint32(long struct, int index)` Unsafe version of `uint32`.
`static void`	`nuint32(long struct, java.nio.IntBuffer value)` Unsafe version of `uint32`.
`static void`	`nuint32(long struct, int index, int value)` Unsafe version of `uint32`.
`VkClearColorValue`	`set(VkClearColorValue src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`java.nio.IntBuffer`	`uint32()` Returns a `IntBuffer` view of the `uint32` field.
`int`	`uint32(int index)` Returns the value at the specified index of the `uint32` field.
`VkClearColorValue`	`uint32(java.nio.IntBuffer value)` Copies the specified `IntBuffer` to the `uint32` field.
`VkClearColorValue`	`uint32(int index, int value)` Sets the specified value at the specified index of the `uint32` field.

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.
  - FLOAT32
```
public static final int FLOAT32
```
    The struct member offsets.
  - INT32
```
public static final int INT32
```
    The struct member offsets.
  - UINT32
```
public static final int UINT32
```
    The struct member offsets.
- Constructor Detail
  - VkClearColorValue
```
public VkClearColorValue(java.nio.ByteBuffer container)
```
    Creates a VkClearColorValue 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
  - float32
```
public java.nio.FloatBuffer float32()
```
    Returns a FloatBuffer view of the float32 field.
  - float32
```
public float float32(int index)
```
    Returns the value at the specified index of the float32 field.
  - int32
```
public java.nio.IntBuffer int32()
```
    Returns a IntBuffer view of the int32 field.
  - int32
```
public int int32(int index)
```
    Returns the value at the specified index of the int32 field.
  - uint32
```
public java.nio.IntBuffer uint32()
```
    Returns a IntBuffer view of the uint32 field.
  - uint32
```
public int uint32(int index)
```
    Returns the value at the specified index of the uint32 field.
  - float32
```
public VkClearColorValue float32(java.nio.FloatBuffer value)
```
    Copies the specified FloatBuffer to the float32 field.
  - float32
```
public VkClearColorValue float32(int index,
                                 float value)
```
    Sets the specified value at the specified index of the float32 field.
  - int32
```
public VkClearColorValue int32(java.nio.IntBuffer value)
```
    Copies the specified IntBuffer to the int32 field.
  - int32
```
public VkClearColorValue int32(int index,
                               int value)
```
    Sets the specified value at the specified index of the int32 field.
  - uint32
```
public VkClearColorValue uint32(java.nio.IntBuffer value)
```
    Copies the specified IntBuffer to the uint32 field.
  - uint32
```
public VkClearColorValue uint32(int index,
                                int value)
```
    Sets the specified value at the specified index of the uint32 field.
  - set
```
public VkClearColorValue set(VkClearColorValue src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkClearColorValue malloc()
```
    Returns a new VkClearColorValue instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkClearColorValue calloc()
```
    Returns a new VkClearColorValue instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkClearColorValue create()
```
    Returns a new VkClearColorValue instance allocated with BufferUtils.
  - create
```
public static VkClearColorValue create(long address)
```
    Returns a new VkClearColorValue instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkClearColorValue createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkClearColorValue.Buffer malloc(int capacity)
```
    Returns a new VkClearColorValue.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkClearColorValue.Buffer calloc(int capacity)
```
    Returns a new VkClearColorValue.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearColorValue.Buffer create(int capacity)
```
    Returns a new VkClearColorValue.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearColorValue.Buffer create(long address,
                                              int capacity)
```
    Create a VkClearColorValue.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkClearColorValue.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkClearColorValue mallocStack()
```
    Returns a new VkClearColorValue instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkClearColorValue callocStack()
```
    Returns a new VkClearColorValue instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkClearColorValue mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearColorValue instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkClearColorValue callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearColorValue instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkClearColorValue.Buffer mallocStack(int capacity)
```
    Returns a new VkClearColorValue.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearColorValue.Buffer callocStack(int capacity)
```
    Returns a new VkClearColorValue.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkClearColorValue.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearColorValue.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearColorValue.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearColorValue.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
  - nfloat32
```
public static java.nio.FloatBuffer nfloat32(long struct)
```
    Unsafe version of float32().
  - nfloat32
```
public static float nfloat32(long struct,
                             int index)
```
    Unsafe version of float32.
  - nint32
```
public static java.nio.IntBuffer nint32(long struct)
```
    Unsafe version of int32().
  - nint32
```
public static int nint32(long struct,
                         int index)
```
    Unsafe version of int32.
  - nuint32
```
public static java.nio.IntBuffer nuint32(long struct)
```
    Unsafe version of uint32().
  - nuint32
```
public static int nuint32(long struct,
                          int index)
```
    Unsafe version of uint32.
  - nfloat32
```
public static void nfloat32(long struct,
                            java.nio.FloatBuffer value)
```
    Unsafe version of float32.
  - nfloat32
```
public static void nfloat32(long struct,
                            int index,
                            float value)
```
    Unsafe version of float32.
  - nint32
```
public static void nint32(long struct,
                          java.nio.IntBuffer value)
```
    Unsafe version of int32.
  - nint32
```
public static void nint32(long struct,
                          int index,
                          int value)
```
    Unsafe version of int32.
  - nuint32
```
public static void nuint32(long struct,
                           java.nio.IntBuffer value)
```
    Unsafe version of uint32.
  - nuint32
```
public static void nuint32(long struct,
                           int index,
                           int value)
```
    Unsafe version of uint32.

Class VkClearColorValue

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

FLOAT32

INT32

UINT32

Constructor Detail

VkClearColorValue

Method Detail

sizeof

float32

float32

int32

int32

uint32

uint32

float32

float32

int32

int32

uint32

uint32

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nfloat32

nfloat32

nint32

nint32

nuint32

nuint32

nfloat32

nfloat32

nint32

nint32

nuint32

nuint32