Class VkAttachmentReference2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAttachmentReference2>

org.lwjgl.vulkan.VkAttachmentReference2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkAttachmentReference2KHR

public class VkAttachmentReference2
extends Struct<VkAttachmentReference2>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	aspectMask()
VkAttachmentReference2	aspectMask(int value)	Sets the specified value to the aspectMask field.
int	attachment()
VkAttachmentReference2	attachment(int value)	Sets the specified value to the attachment field.
static VkAttachmentReference2	calloc()	Returns a new VkAttachmentReference2 instance allocated with memCalloc.
static VkAttachmentReference2.Buffer	calloc(int capacity)	Returns a new VkAttachmentReference2.Buffer instance allocated with memCalloc.
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.
static VkAttachmentReference2	calloc(MemoryStack stack)	Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentReference2	create()	Returns a new VkAttachmentReference2 instance allocated with BufferUtils.
static VkAttachmentReference2.Buffer	create(int capacity)	Returns a new VkAttachmentReference2.Buffer instance allocated with BufferUtils.
static VkAttachmentReference2	create(long address)	Returns a new VkAttachmentReference2 instance for the specified memory address.
static VkAttachmentReference2.Buffer	create(long address, int capacity)	Create a VkAttachmentReference2.Buffer instance at the specified memory.
static @Nullable VkAttachmentReference2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAttachmentReference2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	layout()
VkAttachmentReference2	layout(int value)	Sets the specified value to the layout field.
static VkAttachmentReference2	malloc()	Returns a new VkAttachmentReference2 instance allocated with memAlloc.
static VkAttachmentReference2.Buffer	malloc(int capacity)	Returns a new VkAttachmentReference2.Buffer instance allocated with memAlloc.
static VkAttachmentReference2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkAttachmentReference2.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentReference2	malloc(MemoryStack stack)	Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack.
static int	naspectMask(long struct)	Unsafe version of aspectMask().
static void	naspectMask(long struct, int value)	Unsafe version of aspectMask.
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.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkAttachmentReference2	pNext(long value)	Sets the specified value to the pNext field.
VkAttachmentReference2	pNext(VkAttachmentReferenceStencilLayout value)	Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.
VkAttachmentReference2	pNext(VkAttachmentReferenceStencilLayoutKHR value)	Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.
VkAttachmentReference2	set(int sType, long pNext, int attachment, int layout, int aspectMask)	Initializes this struct with the specified values.
VkAttachmentReference2	set(VkAttachmentReference2 src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkAttachmentReference2	sType(int value)	Sets the specified value to the sType field.
VkAttachmentReference2	sType$Default()	Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

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

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

ATTACHMENT

public static final int ATTACHMENT

The struct member offsets.

LAYOUT

public static final int LAYOUT

The struct member offsets.

ASPECTMASK

public static final int ASPECTMASK

The struct member offsets.

Constructor Details

VkAttachmentReference2

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkAttachmentReference2>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

attachment

@NativeType("uint32_t")
public int attachment()

Returns:

the value of the attachment field.

layout

@NativeType("VkImageLayout")
public int layout()

Returns:

the value of the layout field.

aspectMask

@NativeType("VkImageAspectFlags")
public int aspectMask()

Returns:

the value of the aspectMask field.

sType

public VkAttachmentReference2 sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkAttachmentReference2 sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2 value to the sType field.

pNext

public VkAttachmentReference2 pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayout value)

Prepends the specified VkAttachmentReferenceStencilLayout value to the pNext chain.

pNext

public VkAttachmentReference2 pNext(VkAttachmentReferenceStencilLayoutKHR value)

Prepends the specified VkAttachmentReferenceStencilLayoutKHR value to the pNext chain.

attachment

public VkAttachmentReference2 attachment(@NativeType("uint32_t")
 int value)

Sets the specified value to the attachment field.

layout

public VkAttachmentReference2 layout(@NativeType("VkImageLayout")
 int value)

Sets the specified value to the layout field.

aspectMask

public VkAttachmentReference2 aspectMask(@NativeType("VkImageAspectFlags")
 int value)

Sets the specified value to the aspectMask field.

set

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

Initializes this struct with the specified values.

set

public VkAttachmentReference2 set(VkAttachmentReference2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentReference2 malloc()

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

calloc

public static VkAttachmentReference2 calloc()

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

create

public static VkAttachmentReference2 create()

Returns a new VkAttachmentReference2 instance allocated with BufferUtils.

create

public static VkAttachmentReference2 create(long address)

Returns a new VkAttachmentReference2 instance for the specified memory address.

createSafe

public static @Nullable VkAttachmentReference2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentReference2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentReference2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentReference2.Buffer create(int capacity)

Returns a new VkAttachmentReference2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAttachmentReference2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentReference2 malloc(MemoryStack stack)

Returns a new VkAttachmentReference2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nattachment

public static int nattachment(long struct)

Unsafe version of attachment().

nlayout

public static int nlayout(long struct)

Unsafe version of layout().

naspectMask

public static int naspectMask(long struct)

Unsafe version of aspectMask().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

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.

naspectMask

public static void naspectMask(long struct,
 int value)

Unsafe version of aspectMask.