Class VkClearValue

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkClearValue>

org.lwjgl.vulkan.VkClearValue

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkClearValue
extends Struct<VkClearValue>
implements NativeResource

union VkClearValue {
    VkClearColorValue color;
    VkClearDepthStencilValue depthStencil;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COLOR	The struct member offsets.
static final int	DEPTHSTENCIL	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkClearValue(ByteBuffer container)	Creates a VkClearValue instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkClearValue.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkClearValue	calloc(MemoryStack stack)	Returns a new VkClearValue instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkClearColorValue	color()
VkClearValue	color(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 @Nullable VkClearValue	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkClearValue.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkClearDepthStencilValue	depthStencil()
VkClearValue	depthStencil(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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkClearValue.Buffer instance allocated on the specified MemoryStack.
static VkClearValue	malloc(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()	Returns sizeof(struct).

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

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 Details

VkClearValue

public VkClearValue(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkClearValue>

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

public static @Nullable 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

public static @Nullable VkClearValue.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkClearValue malloc(MemoryStack stack)

Returns a new VkClearValue instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkClearValue calloc(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

malloc

public static VkClearValue.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkClearValue.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

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.