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

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

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

Method Summary

Modifier and Type	Method and Description
public int	aspectMask() a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared.
public VkClearAttachment	aspectMask(int value) Sets the specified value to the `aspectMask` field.
public static VkClearAttachment	calloc() Returns a new `VkClearAttachment` instance allocated with `memCalloc`.
public static VkClearAttachment.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkClearAttachment.Buffer` instance allocated with `memCalloc`.
public static VkClearAttachment	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearAttachment.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearAttachment	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public VkClearValue	clearValue() the color or depth/stencil value to clear the attachment to, as described in Clear Values below.
public VkClearAttachment	clearValue(VkClearValue value) Copies the specified `VkClearValue` to the `clearValue` field.
public VkClearAttachment	clearValue(Consumer<VkClearValue> consumer) Passes the `clearValue` field to the specified `Consumer`.
public int	colorAttachment() only meaningful if `IMAGE_ASPECT_COLOR_BIT` is set in `aspectMask`, in which case it is an index into the currently bound color attachments.
public VkClearAttachment	colorAttachment(int value) Sets the specified value to the `colorAttachment` field.
protected VkClearAttachment	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 VkClearAttachment	create() Returns a new `VkClearAttachment` instance allocated with `BufferUtils`.
public static VkClearAttachment	create(long address) Returns a new `VkClearAttachment` instance for the specified memory address.
public static VkClearAttachment.Buffer	create(int the buffer capacity capacity) Returns a new `VkClearAttachment.Buffer` instance allocated with `BufferUtils`.
public static VkClearAttachment.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkClearAttachment.Buffer` instance at the specified memory.
public static VkClearAttachment	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkClearAttachment.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkClearAttachment	malloc() Returns a new `VkClearAttachment` instance allocated with `memAlloc`.
public static VkClearAttachment.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkClearAttachment.Buffer` instance allocated with `memAlloc`.
public static VkClearAttachment	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack`.
public static VkClearAttachment.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack`.
public static VkClearAttachment	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearAttachment.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	naspectMask(long struct) Unsafe version of `aspectMask`.
public static void	naspectMask(long struct, int value) Unsafe version of `aspectMask`.
public static VkClearValue	nclearValue(long struct) Unsafe version of `clearValue`.
public static void	nclearValue(long struct, VkClearValue value) Unsafe version of `clearValue`.
public static int	ncolorAttachment(long struct) Unsafe version of `colorAttachment`.
public static void	ncolorAttachment(long struct, int value) Unsafe version of `colorAttachment`.
public VkClearAttachment	set(int aspectMask, int colorAttachment, VkClearValue clearValue) Initializes this struct with the specified values.
public VkClearAttachment	Returns: this struct set(VkClearAttachment 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.

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

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

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

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

Constructor Detail

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

VkClearAttachment back to summary

VkClearAttachment	back to summary
public VkClearAttachment(ByteBuffer container) Creates a `VkClearAttachment` 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 VkClearAttachment(ByteBuffer container)

Creates a VkClearAttachment 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

aspectMask	back to summary
public int aspectMask() a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared. Annotations @NativeType:VkImageAspectFlags

aspectMask

back to summary

public int aspectMask()

a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared.

Annotations

@NativeType:VkImageAspectFlags

aspectMask	back to summary
public VkClearAttachment aspectMask(int value) Sets the specified value to the `aspectMask` field.

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

calloc back to summary

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

public static VkClearAttachment.Buffer calloc(int capacity)

Returns a new VkClearAttachment.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 VkClearAttachment calloc(MemoryStack stack) Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkClearAttachment calloc(MemoryStack stack)

Returns a new VkClearAttachment 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 VkClearAttachment.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkClearAttachment.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 VkClearAttachment.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkClearAttachment.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 VkClearAttachment callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment 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 VkClearAttachment callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment 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 VkClearAttachment.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment.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 VkClearAttachment.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

clearValue	back to summary
public VkClearValue clearValue() the color or depth/stencil value to clear the attachment to, as described in Clear Values below.

clearValue	back to summary
public VkClearAttachment clearValue(VkClearValue value) Copies the specified `VkClearValue` to the `clearValue` field.

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

colorAttachment back to summary

colorAttachment	back to summary
public int colorAttachment() only meaningful if `IMAGE_ASPECT_COLOR_BIT` is set in `aspectMask`, in which case it is an index into the currently bound color attachments. Annotations @NativeType:uint32_t

public int colorAttachment()

only meaningful if IMAGE_ASPECT_COLOR_BIT is set in aspectMask, in which case it is an index into the currently bound color attachments.

Annotations

@NativeType:uint32_t

colorAttachment	back to summary
public VkClearAttachment colorAttachment(int value) Sets the specified value to the `colorAttachment` field.

create back to summary

create	back to summary
protected VkClearAttachment 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 VkClearAttachment 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 VkClearAttachment create() Returns a new `VkClearAttachment` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkClearAttachment.Buffer create(int capacity)

Returns a new VkClearAttachment.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkClearAttachment.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 VkClearAttachment createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkClearAttachment createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static VkClearAttachment.Buffer malloc(int capacity)

Returns a new VkClearAttachment.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 VkClearAttachment malloc(MemoryStack stack) Returns a new `VkClearAttachment` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkClearAttachment malloc(MemoryStack stack)

Returns a new VkClearAttachment 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 VkClearAttachment.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkClearAttachment.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new VkClearAttachment.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 VkClearAttachment mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment 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 VkClearAttachment mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment 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 VkClearAttachment.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearAttachment.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 VkClearAttachment.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

naspectMask	back to summary
public static int naspectMask(long struct) Unsafe version of `aspectMask`.

naspectMask	back to summary
public static void naspectMask(long struct, int value) Unsafe version of `aspectMask`.

nclearValue	back to summary
public static VkClearValue nclearValue(long struct) Unsafe version of `clearValue`.

nclearValue	back to summary
public static void nclearValue(long struct, VkClearValue value) Unsafe version of `clearValue`.

ncolorAttachment	back to summary
public static int ncolorAttachment(long struct) Unsafe version of `colorAttachment`.

ncolorAttachment	back to summary
public static void ncolorAttachment(long struct, int value) Unsafe version of `colorAttachment`.

set	back to summary
public VkClearAttachment set(int aspectMask, int colorAttachment, VkClearValue clearValue) Initializes this struct with the specified values.

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

set

back to summary

public VkClearAttachment set(VkClearAttachment src)

Copies the specified struct data to this struct.

Parameters

src:VkClearAttachment: the source struct

Returns:VkClearAttachment

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 VkClearAttachment.Buffer

Class Inheritance

extends StructBuffer<VkClearAttachment, VkClearAttachment.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkClearAttachment.Buffer

All Implemented Interfaces

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

An array of VkClearAttachment structs.

Field Summary

Modifier and Type	Field and Description
private static final VkClearAttachment	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkClearAttachment.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 int	Returns: the value of the `VkClearAttachment#aspectMask` field. aspectMask()
public VkClearAttachment.Buffer	aspectMask(int value) Sets the specified value to the `VkClearAttachment#aspectMask` field.
public VkClearValue	Returns: a `VkClearValue` view of the `VkClearAttachment#clearValue` field. clearValue()
public VkClearAttachment.Buffer	clearValue(VkClearValue value) Copies the specified `VkClearValue` to the `VkClearAttachment#clearValue` field.
public VkClearAttachment.Buffer	clearValue(Consumer<VkClearValue> consumer) Passes the `VkClearAttachment#clearValue` field to the specified `Consumer`.
public int	Returns: the value of the `VkClearAttachment#colorAttachment` field. colorAttachment()
public VkClearAttachment.Buffer	colorAttachment(int value) Sets the specified value to the `VkClearAttachment#colorAttachment` field.
protected VkClearAttachment	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkClearAttachment.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 VkClearAttachment ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkClearAttachment.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 VkClearAttachment#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

aspectMask	back to summary
public int aspectMask() Returns:int the value of the `VkClearAttachment#aspectMask` field. Annotations @NativeType:VkImageAspectFlags

aspectMask	back to summary
public VkClearAttachment.Buffer aspectMask(int value) Sets the specified value to the `VkClearAttachment#aspectMask` field.

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

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

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