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

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

Access	Constructor and Description
protected	VkClearValue(long address, ByteBuffer container)
public	VkClearValue(ByteBuffer container) Creates a `VkClearValue` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkClearValue	calloc() Returns a new `VkClearValue` instance allocated with `memCalloc`.
public static VkClearValue.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkClearValue.Buffer` instance allocated with `memCalloc`.
public static VkClearValue	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearValue` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearValue.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearValue.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearValue	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public VkClearColorValue	color() specifies the color image clear values to use when clearing a color image or attachment.
public VkClearValue	color(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `color` field.
public VkClearValue	color(Consumer<VkClearColorValue> consumer) Passes the `color` field to the specified `Consumer`.
protected VkClearValue	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 VkClearValue	create() Returns a new `VkClearValue` instance allocated with `BufferUtils`.
public static VkClearValue	create(long address) Returns a new `VkClearValue` instance for the specified memory address.
public static VkClearValue.Buffer	create(int the buffer capacity capacity) Returns a new `VkClearValue.Buffer` instance allocated with `BufferUtils`.
public static VkClearValue.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkClearValue.Buffer` instance at the specified memory.
public static VkClearValue	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkClearValue.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public VkClearDepthStencilValue	depthStencil() specifies the depth and stencil clear values to use when clearing a depth/stencil image or attachment.
public VkClearValue	depthStencil(VkClearDepthStencilValue value) Copies the specified `VkClearDepthStencilValue` to the `depthStencil` field.
public VkClearValue	depthStencil(Consumer<VkClearDepthStencilValue> consumer) Passes the `depthStencil` field to the specified `Consumer`.
public static VkClearValue	malloc() Returns a new `VkClearValue` instance allocated with `memAlloc`.
public static VkClearValue.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkClearValue.Buffer` instance allocated with `memAlloc`.
public static VkClearValue	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearValue` instance allocated on the specified `MemoryStack`.
public static VkClearValue.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearValue.Buffer` instance allocated on the specified `MemoryStack`.
public static VkClearValue	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearValue.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearColorValue	ncolor(long struct) Unsafe version of `color`.
public static void	ncolor(long struct, VkClearColorValue value) Unsafe version of `color`.
public static VkClearDepthStencilValue	ndepthStencil(long struct) Unsafe version of `depthStencil`.
public static void	ndepthStencil(long struct, VkClearDepthStencilValue value) Unsafe version of `depthStencil`.
public VkClearValue	Returns: this struct set(VkClearValue 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)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COLOR	back to summary
public static final int COLOR The struct member offsets.

DEPTHSTENCIL	back to summary
public static final int DEPTHSTENCIL The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkClearValue	back to summary
protected VkClearValue(long address, ByteBuffer container)

VkClearValue back to summary

VkClearValue	back to summary
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.

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 Detail

calloc	back to summary
public static VkClearValue calloc() Returns a new `VkClearValue` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkClearValue.Buffer calloc(int capacity) Returns a new `VkClearValue.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkClearValue.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
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:MemoryStack the stack from which to allocate

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:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
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:int the buffer capacity stack:MemoryStack the stack from which to allocate

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:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkClearValue callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearValue callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearValue.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearValue.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

color	back to summary
public VkClearColorValue color() specifies the color image clear values to use when clearing a color image or attachment.

color	back to summary
public VkClearValue color(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `color` field.

color	back to summary
public VkClearValue color(Consumer<VkClearColorValue> consumer) Passes the `color` field to the specified `Consumer`.

create back to summary

create	back to summary
protected VkClearValue 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

protected VkClearValue 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

create	back to summary
public static VkClearValue create() Returns a new `VkClearValue` instance allocated with `BufferUtils`.

create	back to summary
public static VkClearValue create(long address) Returns a new `VkClearValue` instance for the specified memory address.

create back to summary

create	back to summary
public static VkClearValue.Buffer create(int capacity) Returns a new `VkClearValue.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkClearValue.Buffer create(int capacity)

Returns a new VkClearValue.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkClearValue.Buffer create(long address, int capacity) Create a `VkClearValue.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkClearValue.Buffer create(long address, int capacity)

Create a VkClearValue.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkClearValue createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkClearValue createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkClearValue.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

depthStencil	back to summary
public VkClearDepthStencilValue depthStencil() specifies the depth and stencil clear values to use when clearing a depth/stencil image or attachment.

depthStencil	back to summary
public VkClearValue depthStencil(VkClearDepthStencilValue value) Copies the specified `VkClearDepthStencilValue` to the `depthStencil` field.

depthStencil	back to summary
public VkClearValue depthStencil(Consumer<VkClearDepthStencilValue> consumer) Passes the `depthStencil` field to the specified `Consumer`.

malloc	back to summary
public static VkClearValue malloc() Returns a new `VkClearValue` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkClearValue.Buffer malloc(int capacity) Returns a new `VkClearValue.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkClearValue.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkClearValue malloc(MemoryStack stack) Returns a new `VkClearValue` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkClearValue malloc(MemoryStack stack)

Returns a new VkClearValue instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkClearValue.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkClearValue.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkClearValue mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearValue mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearValue.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearValue.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearValue.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

ncolor	back to summary
public static VkClearColorValue ncolor(long struct) Unsafe version of `color`.

ncolor	back to summary
public static void ncolor(long struct, VkClearColorValue value) Unsafe version of `color`.

ndepthStencil	back to summary
public static VkClearDepthStencilValue ndepthStencil(long struct) Unsafe version of `depthStencil`.

ndepthStencil	back to summary
public static void ndepthStencil(long struct, VkClearDepthStencilValue value) Unsafe version of `depthStencil`.

set	back to summary
public VkClearValue set(VkClearValue src) Copies the specified struct data to this struct. Parameters src:VkClearValue the source struct Returns:VkClearValue this struct

set

back to summary

public VkClearValue set(VkClearValue src)

Copies the specified struct data to this struct.

Parameters

src:VkClearValue: the source struct

Returns:VkClearValue

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkClearValue.Buffer

Class Inheritance

extends StructBuffer<VkClearValue, VkClearValue.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkClearValue structs.

Field Summary

Modifier and Type	Field and Description
private static final VkClearValue	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkClearValue.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 Type	Method and Description
public VkClearColorValue	Returns: a `VkClearColorValue` view of the `VkClearValue#color` field. color()
public VkClearValue.Buffer	color(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `VkClearValue#color` field.
public VkClearValue.Buffer	color(Consumer<VkClearColorValue> consumer) Passes the `VkClearValue#color` field to the specified `Consumer`.
public VkClearDepthStencilValue	Returns: a `VkClearDepthStencilValue` view of the `VkClearValue#depthStencil` field. depthStencil()
public VkClearValue.Buffer	depthStencil(VkClearDepthStencilValue value) Copies the specified `VkClearDepthStencilValue` to the `VkClearValue#depthStencil` field.
public VkClearValue.Buffer	depthStencil(Consumer<VkClearDepthStencilValue> consumer) Passes the `VkClearValue#depthStencil` field to the specified `Consumer`.
protected VkClearValue	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkClearValue.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkClearValue ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkClearValue.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 `VkClearValue#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkClearValue.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 VkClearValue#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

color	back to summary
public VkClearColorValue color() Returns:VkClearColorValue a `VkClearColorValue` view of the `VkClearValue#color` field.

color	back to summary
public VkClearValue.Buffer color(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `VkClearValue#color` field.

color	back to summary
public VkClearValue.Buffer color(Consumer<VkClearColorValue> consumer) Passes the `VkClearValue#color` field to the specified `Consumer`.

depthStencil	back to summary
public VkClearDepthStencilValue depthStencil() Returns:VkClearDepthStencilValue a `VkClearDepthStencilValue` view of the `VkClearValue#depthStencil` field.

depthStencil	back to summary
public VkClearValue.Buffer depthStencil(VkClearDepthStencilValue value) Copies the specified `VkClearDepthStencilValue` to the `VkClearValue#depthStencil` field.

depthStencil	back to summary
public VkClearValue.Buffer depthStencil(Consumer<VkClearDepthStencilValue> consumer) Passes the `VkClearValue#depthStencil` field to the specified `Consumer`.