Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkClearColorValue

extends Struct<VkClearColorValue>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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, VkSamplerCustomBorderColorCreateInfoEXT, CmdClearColorImage

Layout


union VkClearColorValue {
    float float32[4];
    int32_t int32[4];
    uint32_t uint32[4];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLOAT32

The struct member offsets.

public static final int
INT32

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
UINT32

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkClearColorValue(long address, ByteBuffer container)

public
VkClearColorValue(ByteBuffer container)

Creates a VkClearColorValue instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkClearColorValue
calloc()

Returns a new VkClearColorValue instance allocated with memCalloc.

public static VkClearColorValue.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkClearColorValue.Buffer instance allocated with memCalloc.

public static VkClearColorValue
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkClearColorValue instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkClearColorValue.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkClearColorValue.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkClearColorValue
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkClearColorValue
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkClearColorValue
create()

Returns a new VkClearColorValue instance allocated with BufferUtils.

public static VkClearColorValue
create(long address)

Returns a new VkClearColorValue instance for the specified memory address.

public static VkClearColorValue.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkClearColorValue.Buffer instance allocated with BufferUtils.

public static VkClearColorValue.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkClearColorValue.Buffer instance at the specified memory.

public static VkClearColorValue
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkClearColorValue.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public FloatBuffer
float32()

are the color clear values when the format of the image or attachment is one of the numeric formats with a numeric type that is floating-point.

public float
float32(int index)

are the color clear values when the format of the image or attachment is one of the numeric formats with a numeric type that is floating-point.

public VkClearColorValue
float32(FloatBuffer value)

Copies the specified FloatBuffer to the float32 field.

public VkClearColorValue
float32(int index, float value)

Sets the specified value at the specified index of the float32 field.

public IntBuffer
int32()

are the color clear values when the format of the image or attachment has a numeric type that is signed integer (SINT).

public int
int32(int index)

are the color clear values when the format of the image or attachment has a numeric type that is signed integer (SINT).

public VkClearColorValue
int32(IntBuffer value)

Copies the specified IntBuffer to the int32 field.

public VkClearColorValue
int32(int index, int value)

Sets the specified value at the specified index of the int32 field.

public static VkClearColorValue
malloc()

Returns a new VkClearColorValue instance allocated with memAlloc.

public static VkClearColorValue.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkClearColorValue.Buffer instance allocated with memAlloc.

public static VkClearColorValue
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkClearColorValue instance allocated on the specified MemoryStack.

public static VkClearColorValue.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkClearColorValue.Buffer instance allocated on the specified MemoryStack.

public static VkClearColorValue
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkClearColorValue.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static FloatBuffer
nfloat32(long struct)

Unsafe version of float32.

public static float
nfloat32(long struct, int index)

Unsafe version of float32.

public static void
nfloat32(long struct, FloatBuffer value)

Unsafe version of float32.

public static void
nfloat32(long struct, int index, float value)

Unsafe version of float32.

public static IntBuffer
nint32(long struct)

Unsafe version of int32.

public static int
nint32(long struct, int index)

Unsafe version of int32.

public static void
nint32(long struct, IntBuffer value)

Unsafe version of int32.

public static void
nint32(long struct, int index, int value)

Unsafe version of int32.

public static IntBuffer
nuint32(long struct)

Unsafe version of uint32.

public static int
nuint32(long struct, int index)

Unsafe version of uint32.

public static void
nuint32(long struct, IntBuffer value)

Unsafe version of uint32.

public static void
nuint32(long struct, int index, int value)

Unsafe version of uint32.

public VkClearColorValue

Returns:

this struct
set
(VkClearColorValue
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public IntBuffer
uint32()

are the color clear values when the format of the image or attachment has a numeric type that is unsigned integer (UINT).

public int
uint32(int index)

are the color clear values when the format of the image or attachment has a numeric type that is unsigned integer (UINT).

public VkClearColorValue
uint32(IntBuffer value)

Copies the specified IntBuffer to the uint32 field.

public VkClearColorValue
uint32(int index, int value)

Sets the specified value at the specified index of the uint32 field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLOAT32back to summary
public static final int FLOAT32

The struct member offsets.

INT32back to summary
public static final int INT32

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

UINT32back to summary
public static final int UINT32

The struct member offsets.

Constructor Detail

VkClearColorValueback to summary
protected VkClearColorValue(long address, ByteBuffer container)
VkClearColorValueback to summary
public VkClearColorValue(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

callocback to summary
public static VkClearColorValue calloc()

Returns a new VkClearColorValue instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkClearColorValue.Buffer calloc(int capacity)

Returns a new VkClearColorValue.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkClearColorValue calloc(MemoryStack stack)

Returns a new VkClearColorValue instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkClearColorValue.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkClearColorValue.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkClearColorValue callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkClearColorValue callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkClearColorValue.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkClearColorValue.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkClearColorValue create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkClearColorValue create()

Returns a new VkClearColorValue instance allocated with BufferUtils.

createback to summary
public static VkClearColorValue create(long address)

Returns a new VkClearColorValue instance for the specified memory address.

createback to summary
public static VkClearColorValue.Buffer create(int capacity)

Returns a new VkClearColorValue.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkClearColorValue.Buffer create(long address, int capacity)

Create a VkClearColorValue.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkClearColorValue createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkClearColorValue.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
float32back to summary
public FloatBuffer float32()

are the color clear values when the format of the image or attachment is one of the numeric formats with a numeric type that is floating-point. 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.

Annotations
@NativeType:float[4]
float32back to summary
public float float32(int index)

are the color clear values when the format of the image or attachment is one of the numeric formats with a numeric type that is floating-point. 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.

float32back to summary
public VkClearColorValue float32(FloatBuffer value)

Copies the specified FloatBuffer to the float32 field.

float32back to summary
public VkClearColorValue float32(int index, float value)

Sets the specified value at the specified index of the float32 field.

int32back to summary
public IntBuffer int32()

are the color clear values when the format of the image or attachment has a numeric type that 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.

Annotations
@NativeType:int32_t[4]
int32back to summary
public int int32(int index)

are the color clear values when the format of the image or attachment has a numeric type that 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.

Annotations
@NativeType:int32_t
int32back to summary
public VkClearColorValue int32(IntBuffer value)

Copies the specified IntBuffer to the int32 field.

int32back to summary
public VkClearColorValue int32(int index, int value)

Sets the specified value at the specified index of the int32 field.

mallocback to summary
public static VkClearColorValue malloc()

Returns a new VkClearColorValue instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkClearColorValue.Buffer malloc(int capacity)

Returns a new VkClearColorValue.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkClearColorValue malloc(MemoryStack stack)

Returns a new VkClearColorValue instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkClearColorValue.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkClearColorValue.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkClearColorValue mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkClearColorValue mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkClearColorValue.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkClearColorValue.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nfloat32back to summary
public static FloatBuffer nfloat32(long struct)

Unsafe version of float32.

nfloat32back to summary
public static float nfloat32(long struct, int index)

Unsafe version of float32.

nfloat32back to summary
public static void nfloat32(long struct, FloatBuffer value)

Unsafe version of float32.

nfloat32back to summary
public static void nfloat32(long struct, int index, float value)

Unsafe version of float32.

nint32back to summary
public static IntBuffer nint32(long struct)

Unsafe version of int32.

nint32back to summary
public static int nint32(long struct, int index)

Unsafe version of int32.

nint32back to summary
public static void nint32(long struct, IntBuffer value)

Unsafe version of int32.

nint32back to summary
public static void nint32(long struct, int index, int value)

Unsafe version of int32.

nuint32back to summary
public static IntBuffer nuint32(long struct)

Unsafe version of uint32.

nuint32back to summary
public static int nuint32(long struct, int index)

Unsafe version of uint32.

nuint32back to summary
public static void nuint32(long struct, IntBuffer value)

Unsafe version of uint32.

nuint32back to summary
public static void nuint32(long struct, int index, int value)

Unsafe version of uint32.

setback to summary
public VkClearColorValue set(VkClearColorValue src)

Copies the specified struct data to this struct.

Parameters
src:VkClearColorValue

the source struct

Returns:VkClearColorValue

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
uint32back to summary
public IntBuffer uint32()

are the color clear values when the format of the image or attachment has a numeric type that is unsigned integer (UINT). Unsigned integer values are converted to the format of the image by casting to the integer type with fewer bits.

Annotations
@NativeType:uint32_t[4]
uint32back to summary
public int uint32(int index)

are the color clear values when the format of the image or attachment has a numeric type that is unsigned integer (UINT). Unsigned integer values are converted to the format of the image by casting to the integer type with fewer bits.

Annotations
@NativeType:uint32_t
uint32back to summary
public VkClearColorValue uint32(IntBuffer value)

Copies the specified IntBuffer to the uint32 field.

uint32back to summary
public VkClearColorValue uint32(int index, int value)

Sets the specified value at the specified index of the uint32 field.

org.lwjgl.vulkan back to summary

public Class VkClearColorValue.Buffer

extends StructBuffer<VkClearColorValue, VkClearColorValue.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkClearColorValue structs.

Field Summary

Modifier and TypeField and Description
private static final VkClearColorValue

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkClearColorValue.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public FloatBuffer

Returns:

a FloatBuffer view of the VkClearColorValue#float32 field.
float32
()

public float

Returns:

the value at the specified index of the VkClearColorValue#float32 field.
float32
(int index)

public VkClearColorValue.Buffer
float32(FloatBuffer value)

Copies the specified FloatBuffer to the VkClearColorValue#float32 field.

public VkClearColorValue.Buffer
float32(int index, float value)

Sets the specified value at the specified index of the VkClearColorValue#float32 field.

protected VkClearColorValue
public IntBuffer

Returns:

a IntBuffer view of the VkClearColorValue#int32 field.
int32
()

public int

Returns:

the value at the specified index of the VkClearColorValue#int32 field.
int32
(int index)

public VkClearColorValue.Buffer
int32(IntBuffer value)

Copies the specified IntBuffer to the VkClearColorValue#int32 field.

public VkClearColorValue.Buffer
int32(int index, int value)

Sets the specified value at the specified index of the VkClearColorValue#int32 field.

protected VkClearColorValue.Buffer
public IntBuffer

Returns:

a IntBuffer view of the VkClearColorValue#uint32 field.
uint32
()

public int

Returns:

the value at the specified index of the VkClearColorValue#uint32 field.
uint32
(int index)

public VkClearColorValue.Buffer
uint32(IntBuffer value)

Copies the specified IntBuffer to the VkClearColorValue#uint32 field.

public VkClearColorValue.Buffer
uint32(int index, int value)

Sets the specified value at the specified index of the VkClearColorValue#uint32 field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkClearColorValue ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkClearColorValue.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkClearColorValue#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

float32back to summary
public FloatBuffer float32()
Returns:FloatBuffer

a FloatBuffer view of the VkClearColorValue#float32 field.

Annotations
@NativeType:float[4]
float32back to summary
public float float32(int index)
Returns:float

the value at the specified index of the VkClearColorValue#float32 field.

float32back to summary
public VkClearColorValue.Buffer float32(FloatBuffer value)

Copies the specified FloatBuffer to the VkClearColorValue#float32 field.

float32back to summary
public VkClearColorValue.Buffer float32(int index, float value)

Sets the specified value at the specified index of the VkClearColorValue#float32 field.

getElementFactoryback to summary
protected VkClearColorValue getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
int32back to summary
public IntBuffer int32()
Returns:IntBuffer

a IntBuffer view of the VkClearColorValue#int32 field.

Annotations
@NativeType:int32_t[4]
int32back to summary
public int int32(int index)
Returns:int

the value at the specified index of the VkClearColorValue#int32 field.

Annotations
@NativeType:int32_t
int32back to summary
public VkClearColorValue.Buffer int32(IntBuffer value)

Copies the specified IntBuffer to the VkClearColorValue#int32 field.

int32back to summary
public VkClearColorValue.Buffer int32(int index, int value)

Sets the specified value at the specified index of the VkClearColorValue#int32 field.

selfback to summary
protected VkClearColorValue.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
uint32back to summary
public IntBuffer uint32()
Returns:IntBuffer

a IntBuffer view of the VkClearColorValue#uint32 field.

Annotations
@NativeType:uint32_t[4]
uint32back to summary
public int uint32(int index)
Returns:int

the value at the specified index of the VkClearColorValue#uint32 field.

Annotations
@NativeType:uint32_t
uint32back to summary
public VkClearColorValue.Buffer uint32(IntBuffer value)

Copies the specified IntBuffer to the VkClearColorValue#uint32 field.

uint32back to summary
public VkClearColorValue.Buffer uint32(int index, int value)

Sets the specified value at the specified index of the VkClearColorValue#uint32 field.