Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAttachmentReference2KHR

extends VkAttachmentReference2
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
See VkAttachmentReference2.

Layout


struct VkAttachmentReference2KHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t attachment;
    VkImageLayout layout;
    VkImageAspectFlags aspectMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkAttachmentReference2KHR.Buffer

An array of VkAttachmentReference2KHR structs.

Field Summary

Inherited from org.lwjgl.vulkan.VkAttachmentReference2:
ALIGNOFASPECTMASKATTACHMENTLAYOUTPNEXTSIZEOFSTYPE

Constructor Summary

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

public
VkAttachmentReference2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public VkAttachmentReference2KHR
aspectMask(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.aspectMask.

Sets the specified value to the aspectMask field.
public VkAttachmentReference2KHR
attachment(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.attachment.

Sets the specified value to the attachment field.
public static VkAttachmentReference2KHR
calloc()

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

Returns a new VkAttachmentReference2KHR instance allocated with memCalloc.
public static VkAttachmentReference2KHR.Buffer
calloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated with memCalloc.
public static VkAttachmentReference2KHR
calloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

Returns a new VkAttachmentReference2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkAttachmentReference2KHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkAttachmentReference2KHR
callocStack()

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

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

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

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

Overrides org.lwjgl.vulkan.VkAttachmentReference2.create.

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR instance allocated with BufferUtils.
public static VkAttachmentReference2KHR
create(long address)

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR instance for the specified memory address.
public static VkAttachmentReference2KHR.Buffer
create(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated with BufferUtils.
public static VkAttachmentReference2KHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Create a VkAttachmentReference2KHR.Buffer instance at the specified memory.
public static VkAttachmentReference2KHR
createSafe(long address)

Hides org.lwjgl.vulkan.VkAttachmentReference2.createSafe.

Like create, but returns null if address is NULL.
public static VkAttachmentReference2KHR.Buffer
createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkAttachmentReference2.createSafe.

Like create, but returns null if address is NULL.
public VkAttachmentReference2KHR
layout(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.layout.

Sets the specified value to the layout field.
public static VkAttachmentReference2KHR
malloc()

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR instance allocated with memAlloc.
public static VkAttachmentReference2KHR.Buffer
malloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated with memAlloc.
public static VkAttachmentReference2KHR
malloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR instance allocated on the specified MemoryStack.
public static VkAttachmentReference2KHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated on the specified MemoryStack.
public static VkAttachmentReference2KHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public VkAttachmentReference2KHR
pNext(long value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.pNext.

Sets the specified value to the pNext field.
public VkAttachmentReference2KHR
set(int sType, long pNext, int attachment, int layout, int aspectMask)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.set.

Initializes this struct with the specified values.
public VkAttachmentReference2KHR

Returns:

this struct
set(VkAttachmentReference2KHR
the source struct
src)

Copies the specified struct data to this struct.

public VkAttachmentReference2KHR
sType(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.sType.

Sets the specified value to the sType field.
public VkAttachmentReference2KHR
sType$Default()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.sType$Default.

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkAttachmentReference2:
aspectMaskattachmentlayoutnaspectMasknaspectMasknattachmentnattachmentnlayoutnlayoutnpNextnpNextnsTypensTypepNextpNextpNextsetsizeofsType

Constructor Detail

VkAttachmentReference2KHRback to summary
protected VkAttachmentReference2KHR(long address, ByteBuffer container)
VkAttachmentReference2KHRback to summary
public VkAttachmentReference2KHR(ByteBuffer container)

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

aspectMaskback to summary
public VkAttachmentReference2KHR aspectMask(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.aspectMask.

Sets the specified value to the aspectMask field.

Annotations
@Override
attachmentback to summary
public VkAttachmentReference2KHR attachment(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.attachment.

Sets the specified value to the attachment field.

Annotations
@Override
callocback to summary
public static VkAttachmentReference2KHR calloc()

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

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

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAttachmentReference2KHR calloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.calloc.

Returns a new VkAttachmentReference2KHR.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 VkAttachmentReference2KHR callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkAttachmentReference2KHR.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 VkAttachmentReference2KHR create(long address, ByteBuffer container)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.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 VkAttachmentReference2KHR create()

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR instance allocated with BufferUtils.

createback to summary
public static VkAttachmentReference2KHR create(long address)

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR instance for the specified memory address.

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Returns a new VkAttachmentReference2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.create.

Create a VkAttachmentReference2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAttachmentReference2KHR createSafe(long address)

Hides org.lwjgl.vulkan.VkAttachmentReference2.createSafe.

Like create, but returns null if address is NULL.

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
layoutback to summary
public VkAttachmentReference2KHR layout(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.layout.

Sets the specified value to the layout field.

Annotations
@Override
mallocback to summary
public static VkAttachmentReference2KHR malloc()

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

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

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAttachmentReference2KHR malloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Hides org.lwjgl.vulkan.VkAttachmentReference2.malloc.

Returns a new VkAttachmentReference2KHR.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 VkAttachmentReference2KHR mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
pNextback to summary
public VkAttachmentReference2KHR pNext(long value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
setback to summary
public VkAttachmentReference2KHR set(int sType, long pNext, int attachment, int layout, int aspectMask)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.set.

Initializes this struct with the specified values.

Annotations
@Override
setback to summary
public VkAttachmentReference2KHR set(VkAttachmentReference2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAttachmentReference2KHR

the source struct

Returns:VkAttachmentReference2KHR

this struct

sTypeback to summary
public VkAttachmentReference2KHR sType(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkAttachmentReference2KHR sType$Default()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.sType$Default.

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkAttachmentReference2KHR.Buffer

extends Buffer
Class Inheritance
An array of VkAttachmentReference2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAttachmentReference2KHR
ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.ELEMENT_FACTORY.

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAttachmentReference2KHR.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 VkAttachmentReference2KHR.Buffer
aspectMask(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.aspectMask.

Sets the specified value to the aspectMask field.
public VkAttachmentReference2KHR.Buffer
attachment(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.attachment.

Sets the specified value to the attachment field.
protected VkAttachmentReference2KHR
getElementFactory()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.getElementFactory.

public VkAttachmentReference2KHR.Buffer
layout(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.layout.

Sets the specified value to the layout field.
public VkAttachmentReference2KHR.Buffer
pNext(long value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.pNext.

Sets the specified value to the pNext field.
protected VkAttachmentReference2KHR.Buffer
self()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.self.

public VkAttachmentReference2KHR.Buffer
sType(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.sType.

Sets the specified value to the sType field.
public VkAttachmentReference2KHR.Buffer
sType$Default()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkAttachmentReference2.Buffer:
aspectMaskattachmentlayoutpNextpNextpNextsType

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAttachmentReference2KHR ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.ELEMENT_FACTORY.

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

aspectMaskback to summary
public VkAttachmentReference2KHR.Buffer aspectMask(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.aspectMask.

Sets the specified value to the aspectMask field.

Annotations
@Override
attachmentback to summary
public VkAttachmentReference2KHR.Buffer attachment(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.attachment.

Sets the specified value to the attachment field.

Annotations
@Override
getElementFactoryback to summary
protected VkAttachmentReference2KHR getElementFactory()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.getElementFactory.

Annotations
@Override
layoutback to summary
public VkAttachmentReference2KHR.Buffer layout(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.layout.

Sets the specified value to the layout field.

Annotations
@Override
pNextback to summary
public VkAttachmentReference2KHR.Buffer pNext(long value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
selfback to summary
protected VkAttachmentReference2KHR.Buffer self()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.self.

Annotations
@Override
sTypeback to summary
public VkAttachmentReference2KHR.Buffer sType(int value)

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkAttachmentReference2KHR.Buffer sType$Default()

Overrides org.lwjgl.vulkan.VkAttachmentReference2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.

Annotations
@Override