Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAttachmentReference2

extends Struct<VkAttachmentReference2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkAttachmentReference2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying an attachment reference.
Description

Parameters defined by this structure with the same name as those in VkAttachmentReference have the identical effect to those parameters.

aspectMask is ignored when this structure is used to describe anything other than an input attachment reference.

If the separateDepthStencilLayouts feature is enabled, and attachment has a depth/stencil format, layout can be set to a layout that only specifies the layout of the depth aspect.

If layout only specifies the layout of the depth aspect of the attachment, the layout of the stencil aspect is specified by the stencilLayout member of a VkAttachmentReferenceStencilLayout structure included in the pNext chain. Otherwise, layout describes the layout for all relevant image aspects.

Valid Usage
Valid Usage (Implicit)
See Also

VkFragmentShadingRateAttachmentInfoKHR, VkSubpassDescription2, VkSubpassDescriptionDepthStencilResolve

Layout


struct VkAttachmentReference2 {
    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

Field Summary

Modifier and TypeField 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
ATTACHMENT

The struct member offsets.

public static final int
LAYOUT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkAttachmentReference2(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
aspectMask()

a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.

public VkAttachmentReference2
aspectMask(int value)

Sets the specified value to the aspectMask field.

public int
attachment()

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

public VkAttachmentReference2
attachment(int value)

Sets the specified value to the attachment field.

public static VkAttachmentReference2
calloc()

Returns a new VkAttachmentReference2 instance allocated with memCalloc.

public static VkAttachmentReference2.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkAttachmentReference2.Buffer instance allocated with memCalloc.

public static VkAttachmentReference2
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkAttachmentReference2.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkAttachmentReference2
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 VkAttachmentReference2
create()

Returns a new VkAttachmentReference2 instance allocated with BufferUtils.

public static VkAttachmentReference2
create(long address)

Returns a new VkAttachmentReference2 instance for the specified memory address.

public static VkAttachmentReference2.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkAttachmentReference2.Buffer instance allocated with BufferUtils.

public static VkAttachmentReference2.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkAttachmentReference2.Buffer instance at the specified memory.

public static VkAttachmentReference2
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkAttachmentReference2.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 VkAttachmentReference2
layout(int value)

Sets the specified value to the layout field.

public static VkAttachmentReference2
malloc()

Returns a new VkAttachmentReference2 instance allocated with memAlloc.

public static VkAttachmentReference2.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkAttachmentReference2.Buffer instance allocated with memAlloc.

public static VkAttachmentReference2
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack.

public static VkAttachmentReference2.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
naspectMask(long struct)

Unsafe version of aspectMask.

public static void
naspectMask(long struct, int value)

Unsafe version of aspectMask.

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 static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkAttachmentReference2
pNext(long value)

Sets the specified value to the pNext field.

public VkAttachmentReference2
pNext(VkAttachmentReferenceStencilLayout value)

Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.

public VkAttachmentReference2
pNext(VkAttachmentReferenceStencilLayoutKHR value)

Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.

public VkAttachmentReference2
set(int sType, long pNext, int attachment, int layout, int aspectMask)

Initializes this struct with the specified values.

public VkAttachmentReference2

Returns:

this struct
set
(VkAttachmentReference2
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).
public int
sType()

a VkStructureType value identifying this structure.

public VkAttachmentReference2
sType(int value)

Sets the specified value to the sType field.

public VkAttachmentReference2
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ASPECTMASKback to summary
public static final int ASPECTMASK

The struct member offsets.

ATTACHMENTback to summary
public static final int ATTACHMENT

The struct member offsets.

LAYOUTback to summary
public static final int LAYOUT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkAttachmentReference2back to summary
protected VkAttachmentReference2(long address, ByteBuffer container)
VkAttachmentReference2back to summary
public VkAttachmentReference2(ByteBuffer container)

Creates a VkAttachmentReference2 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 int aspectMask()

a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkAttachmentReference2 aspectMask(int value)

Sets the specified value to the aspectMask field.

attachmentback to summary
public int attachment()

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

Annotations
@NativeType:uint32_t
attachmentback to summary
public VkAttachmentReference2 attachment(int value)

Sets the specified value to the attachment field.

callocback to summary
public static VkAttachmentReference2 calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAttachmentReference2 calloc(MemoryStack stack)

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

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

createback to summary
protected VkAttachmentReference2 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
createback to summary
public static VkAttachmentReference2 create()

Returns a new VkAttachmentReference2 instance allocated with BufferUtils.

createback to summary
public static VkAttachmentReference2 create(long address)

Returns a new VkAttachmentReference2 instance for the specified memory address.

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

Returns a new VkAttachmentReference2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAttachmentReference2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAttachmentReference2 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
layoutback to summary
public int layout()

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

Annotations
@NativeType:VkImageLayout
layoutback to summary
public VkAttachmentReference2 layout(int value)

Sets the specified value to the layout field.

mallocback to summary
public static VkAttachmentReference2 malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAttachmentReference2 malloc(MemoryStack stack)

Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

naspectMaskback to summary
public static int naspectMask(long struct)

Unsafe version of aspectMask.

naspectMaskback to summary
public static void naspectMask(long struct, int value)

Unsafe version of aspectMask.

nattachmentback to summary
public static int nattachment(long struct)

Unsafe version of attachment.

nattachmentback to summary
public static void nattachment(long struct, int value)

Unsafe version of attachment.

nlayoutback to summary
public static int nlayout(long struct)

Unsafe version of layout.

nlayoutback to summary
public static void nlayout(long struct, int value)

Unsafe version of layout.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkAttachmentReference2 pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayout value)

Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.

pNextback to summary
public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayoutKHR value)

Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.

setback to summary
public VkAttachmentReference2 set(int sType, long pNext, int attachment, int layout, int aspectMask)

Initializes this struct with the specified values.

setback to summary
public VkAttachmentReference2 set(VkAttachmentReference2 src)

Copies the specified struct data to this struct.

Parameters
src:VkAttachmentReference2

the source struct

Returns:VkAttachmentReference2

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAttachmentReference2 sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkAttachmentReference2 sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkAttachmentReference2.Buffer

extends StructBuffer<VkAttachmentReference2, VkAttachmentReference2.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkAttachmentReference2KHR.Buffer

An array of VkAttachmentReference2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkAttachmentReference2

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAttachmentReference2.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 int

Returns:

the value of the VkAttachmentReference2#aspectMask field.
aspectMask
()

public VkAttachmentReference2.Buffer
aspectMask(int value)

Sets the specified value to the VkAttachmentReference2#aspectMask field.

public int

Returns:

the value of the VkAttachmentReference2#attachment field.
attachment
()

public VkAttachmentReference2.Buffer
attachment(int value)

Sets the specified value to the VkAttachmentReference2#attachment field.

protected VkAttachmentReference2
public int

Returns:

the value of the VkAttachmentReference2#layout field.
layout
()

public VkAttachmentReference2.Buffer
layout(int value)

Sets the specified value to the VkAttachmentReference2#layout field.

public long

Returns:

the value of the VkAttachmentReference2#pNext field.
pNext
()

public VkAttachmentReference2.Buffer
pNext(long value)

Sets the specified value to the VkAttachmentReference2#pNext field.

public VkAttachmentReference2.Buffer
pNext(VkAttachmentReferenceStencilLayout value)

Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.

public VkAttachmentReference2.Buffer
pNext(VkAttachmentReferenceStencilLayoutKHR value)

Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.

protected VkAttachmentReference2.Buffer
public int

Returns:

the value of the VkAttachmentReference2#sType field.
sType
()

public VkAttachmentReference2.Buffer
sType(int value)

Sets the specified value to the VkAttachmentReference2#sType field.

public VkAttachmentReference2.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAttachmentReference2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkAttachmentReference2.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 VkAttachmentReference2#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 int aspectMask()
Returns:int

the value of the VkAttachmentReference2#aspectMask field.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkAttachmentReference2.Buffer aspectMask(int value)

Sets the specified value to the VkAttachmentReference2#aspectMask field.

attachmentback to summary
public int attachment()
Returns:int

the value of the VkAttachmentReference2#attachment field.

Annotations
@NativeType:uint32_t
attachmentback to summary
public VkAttachmentReference2.Buffer attachment(int value)

Sets the specified value to the VkAttachmentReference2#attachment field.

getElementFactoryback to summary
protected VkAttachmentReference2 getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
layoutback to summary
public int layout()
Returns:int

the value of the VkAttachmentReference2#layout field.

Annotations
@NativeType:VkImageLayout
layoutback to summary
public VkAttachmentReference2.Buffer layout(int value)

Sets the specified value to the VkAttachmentReference2#layout field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkAttachmentReference2#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkAttachmentReference2.Buffer pNext(long value)

Sets the specified value to the VkAttachmentReference2#pNext field.

pNextback to summary
public VkAttachmentReference2.Buffer pNext(VkAttachmentReferenceStencilLayout value)

Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.

pNextback to summary
public VkAttachmentReference2.Buffer pNext(VkAttachmentReferenceStencilLayoutKHR value)

Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.

selfback to summary
protected VkAttachmentReference2.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkAttachmentReference2#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAttachmentReference2.Buffer sType(int value)

Sets the specified value to the VkAttachmentReference2#sType field.

sType$Defaultback to summary
public VkAttachmentReference2.Buffer sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the VkAttachmentReference2#sType field.