Package org.lwjgl.vulkan

Class VkAttachmentReference

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAttachmentReference>

org.lwjgl.vulkan.VkAttachmentReference

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkAttachmentReference
extends org.lwjgl.system.Struct<VkAttachmentReference>
implements org.lwjgl.system.NativeResource

Structure specifying an attachment reference.

Valid Usage

• If attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, or IMAGE_LAYOUT_PRESENT_SRC_KHR
• If the separateDepthStencilLayouts feature is not enabled, and attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
• If the synchronization2 feature is not enabled, layout must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
• If the attachmentFeedbackLoopLayout feature is not enabled, layout must not be IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
• If the dynamicRenderingLocalRead feature is not enabled, layout must not be IMAGE_LAYOUT_RENDERING_LOCAL_READ

Valid Usage (Implicit)

• layout must be a valid VkImageLayout value

See Also

VkRenderPassFragmentDensityMapCreateInfoEXT, VkSubpassDescription

Layout

 struct VkAttachmentReference {
     uint32_t attachment();
     VkImageLayout layout();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
VkAttachmentReference	attachment(int value)	Sets the specified value to the attachment() field.
static VkAttachmentReference	calloc()	Returns a new VkAttachmentReference instance allocated with memCalloc.
static VkAttachmentReference.Buffer	calloc(int capacity)	Returns a new VkAttachmentReference.Buffer instance allocated with memCalloc.
static VkAttachmentReference.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReference.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentReference	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReference instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentReference	callocStack()	Deprecated.
static VkAttachmentReference.Buffer	callocStack(int capacity)	Deprecated.
static VkAttachmentReference.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentReference	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentReference	create()	Returns a new VkAttachmentReference instance allocated with BufferUtils.
static VkAttachmentReference.Buffer	create(int capacity)	Returns a new VkAttachmentReference.Buffer instance allocated with BufferUtils.
static VkAttachmentReference	create(long address)	Returns a new VkAttachmentReference instance for the specified memory address.
static VkAttachmentReference.Buffer	create(long address, int capacity)	Create a VkAttachmentReference.Buffer instance at the specified memory.
static @Nullable VkAttachmentReference	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAttachmentReference.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	layout()	a VkImageLayout value specifying the layout the attachment uses during the subpass.
VkAttachmentReference	layout(int value)	Sets the specified value to the layout() field.
static VkAttachmentReference	malloc()	Returns a new VkAttachmentReference instance allocated with memAlloc.
static VkAttachmentReference.Buffer	malloc(int capacity)	Returns a new VkAttachmentReference.Buffer instance allocated with memAlloc.
static VkAttachmentReference.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReference.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentReference	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReference instance allocated on the specified MemoryStack.
static VkAttachmentReference	mallocStack()	Deprecated.
static VkAttachmentReference.Buffer	mallocStack(int capacity)	Deprecated.
static VkAttachmentReference.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentReference	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nattachment(long struct)	Unsafe version of attachment().
static void	nattachment(long struct, int value)	Unsafe version of attachment.
static int	nlayout(long struct)	Unsafe version of layout().
static void	nlayout(long struct, int value)	Unsafe version of layout.
VkAttachmentReference	set(int attachment, int layout)	Initializes this struct with the specified values.
VkAttachmentReference	set(VkAttachmentReference src)	Copies the specified struct data to this struct.
int	sizeof()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.

ATTACHMENT

public static final int ATTACHMENT

The struct member offsets.

LAYOUT

public static final int LAYOUT

The struct member offsets.

Constructor Details

VkAttachmentReference

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkAttachmentReference>

attachment

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.

layout

public int layout()

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

attachment

public VkAttachmentReference attachment(int value)

Sets the specified value to the attachment() field.

layout

public VkAttachmentReference layout(int value)

Sets the specified value to the layout() field.

set

public VkAttachmentReference set(int attachment,
 int layout)

Initializes this struct with the specified values.

set

public VkAttachmentReference set(VkAttachmentReference src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentReference malloc()

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

calloc

public static VkAttachmentReference calloc()

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

create

public static VkAttachmentReference create()

Returns a new VkAttachmentReference instance allocated with BufferUtils.

create

public static VkAttachmentReference create(long address)

Returns a new VkAttachmentReference instance for the specified memory address.

createSafe

public static @Nullable VkAttachmentReference createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentReference.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentReference.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentReference.Buffer create(int capacity)

Returns a new VkAttachmentReference.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAttachmentReference.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkAttachmentReference mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentReference callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkAttachmentReference mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentReference callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkAttachmentReference.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentReference.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkAttachmentReference.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentReference.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkAttachmentReference malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentReference instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAttachmentReference calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAttachmentReference.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentReference.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

nattachment

public static int nattachment(long struct)

Unsafe version of attachment().

nlayout

public static int nlayout(long struct)

Unsafe version of layout().

nattachment

public static void nattachment(long struct,
 int value)

Unsafe version of attachment.

nlayout

public static void nlayout(long struct,
 int value)

Unsafe version of layout.