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

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

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

Method Summary

Modifier and Type	Method and Description
public int	attachment() either an integer value identifying an attachment at the corresponding index in `VkRenderPassCreateInfo::pAttachments`, or `ATTACHMENT_UNUSED` to signify that this attachment is not used.
public VkAttachmentReference	attachment(int value) Sets the specified value to the `attachment` field.
public static VkAttachmentReference	calloc() Returns a new `VkAttachmentReference` instance allocated with `memCalloc`.
public static VkAttachmentReference.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkAttachmentReference.Buffer` instance allocated with `memCalloc`.
public static VkAttachmentReference	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentReference` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAttachmentReference.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAttachmentReference	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkAttachmentReference	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 VkAttachmentReference	create() Returns a new `VkAttachmentReference` instance allocated with `BufferUtils`.
public static VkAttachmentReference	create(long address) Returns a new `VkAttachmentReference` instance for the specified memory address.
public static VkAttachmentReference.Buffer	create(int the buffer capacity capacity) Returns a new `VkAttachmentReference.Buffer` instance allocated with `BufferUtils`.
public static VkAttachmentReference.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkAttachmentReference.Buffer` instance at the specified memory.
public static VkAttachmentReference	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkAttachmentReference.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	layout() a `VkImageLayout` value specifying the layout the attachment uses during the subpass.
public VkAttachmentReference	layout(int value) Sets the specified value to the `layout` field.
public static VkAttachmentReference	malloc() Returns a new `VkAttachmentReference` instance allocated with `memAlloc`.
public static VkAttachmentReference.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkAttachmentReference.Buffer` instance allocated with `memAlloc`.
public static VkAttachmentReference	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentReference` instance allocated on the specified `MemoryStack`.
public static VkAttachmentReference.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentReference.Buffer` instance allocated on the specified `MemoryStack`.
public static VkAttachmentReference	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkAttachmentReference.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nattachment(long struct) Unsafe version of `attachment`.
public static void	nattachment(long struct, int value) Unsafe version of `attachment`.
public static int	nlayout(long struct) Unsafe version of `layout`.
public static void	nlayout(long struct, int value) Unsafe version of `layout`.
public VkAttachmentReference	set(int attachment, int layout) Initializes this struct with the specified values.
public VkAttachmentReference	Returns: this struct set(VkAttachmentReference 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.

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

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

LAYOUT

back to summary

public static final int LAYOUT

The struct member offsets.

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

Constructor Detail

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

VkAttachmentReference back to summary

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

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

attachment back to summary

attachment	back to summary
public int attachment() either an integer value identifying an attachment at the corresponding index in `VkRenderPassCreateInfo::pAttachments`, or `ATTACHMENT_UNUSED` to signify that this attachment is not used. Annotations @NativeType:uint32_t

public int attachment()

either an integer value identifying an attachment at the corresponding index in VkRenderPassCreateInfo::pAttachments, or ATTACHMENT_UNUSED to signify that this attachment is not used.

Annotations

@NativeType:uint32_t

attachment	back to summary
public VkAttachmentReference attachment(int value) Sets the specified value to the `attachment` field.

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

calloc back to summary

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

public static VkAttachmentReference.Buffer calloc(int capacity)

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

public static VkAttachmentReference calloc(MemoryStack stack)

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

create back to summary

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

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

create back to summary

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

public static VkAttachmentReference.Buffer create(int capacity)

Returns a new VkAttachmentReference.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkAttachmentReference createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

layout back to summary

layout	back to summary
public int layout() a `VkImageLayout` value specifying the layout the attachment uses during the subpass. Annotations @NativeType:VkImageLayout

public int layout()

a VkImageLayout value specifying the layout the attachment uses during the subpass.

Annotations

@NativeType:VkImageLayout

layout back to summary

layout	back to summary
public VkAttachmentReference layout(int value) Sets the specified value to the `layout` field.

public VkAttachmentReference layout(int value)

Sets the specified value to the layout field.

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

malloc back to summary

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

public static VkAttachmentReference.Buffer malloc(int capacity)

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

public static VkAttachmentReference malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nattachment	back to summary
public static int nattachment(long struct) Unsafe version of `attachment`.

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

nlayout	back to summary
public static int nlayout(long struct) Unsafe version of `layout`.

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

set	back to summary
public VkAttachmentReference set(int attachment, int layout) Initializes this struct with the specified values.

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

set

back to summary

public VkAttachmentReference set(VkAttachmentReference src)

Copies the specified struct data to this struct.

Parameters

src:VkAttachmentReference: the source struct

Returns:VkAttachmentReference

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

Class Inheritance

extends StructBuffer<VkAttachmentReference, VkAttachmentReference.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkAttachmentReference structs.

Field Summary

Modifier and Type	Field and Description
private static final VkAttachmentReference	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkAttachmentReference.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 `VkAttachmentReference#attachment` field. attachment()
public VkAttachmentReference.Buffer	attachment(int value) Sets the specified value to the `VkAttachmentReference#attachment` field.
protected VkAttachmentReference	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkAttachmentReference#layout` field. layout()
public VkAttachmentReference.Buffer	layout(int value) Sets the specified value to the `VkAttachmentReference#layout` field.
protected VkAttachmentReference.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 VkAttachmentReference ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkAttachmentReference.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 `VkAttachmentReference#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 VkAttachmentReference.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 VkAttachmentReference#SIZEOF, and its mark will be undefined.

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