Package org.lwjgl.vulkan

Class VkRenderingAttachmentInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingAttachmentInfo>

org.lwjgl.vulkan.VkRenderingAttachmentInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkRenderingAttachmentInfoKHR

public class VkRenderingAttachmentInfo
extends Struct<VkRenderingAttachmentInfo>
implements NativeResource

 struct VkRenderingAttachmentInfo {
     VkStructureType sType;
     void const * pNext;
     VkImageView imageView;
     VkImageLayout imageLayout;
     VkResolveModeFlagBits resolveMode;
     VkImageView resolveImageView;
     VkImageLayout resolveImageLayout;
     VkAttachmentLoadOp loadOp;
     VkAttachmentStoreOp storeOp;
     {@link VkClearValue VkClearValue} clearValue;
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CLEARVALUE	The struct member offsets.
static final int	IMAGELAYOUT	The struct member offsets.
static final int	IMAGEVIEW	The struct member offsets.
static final int	LOADOP	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	RESOLVEIMAGELAYOUT	The struct member offsets.
static final int	RESOLVEIMAGEVIEW	The struct member offsets.
static final int	RESOLVEMODE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STOREOP	The struct member offsets.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingAttachmentInfo	calloc()	Returns a new VkRenderingAttachmentInfo instance allocated with memCalloc.
static VkRenderingAttachmentInfo.Buffer	calloc(int capacity)	Returns a new VkRenderingAttachmentInfo.Buffer instance allocated with memCalloc.
static VkRenderingAttachmentInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAttachmentInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingAttachmentInfo	calloc(MemoryStack stack)	Returns a new VkRenderingAttachmentInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkClearValue	clearValue()
VkRenderingAttachmentInfo	clearValue(Consumer<VkClearValue> consumer)	Passes the clearValue field to the specified Consumer.
VkRenderingAttachmentInfo	clearValue(VkClearValue value)	Copies the specified VkClearValue to the clearValue field.
static VkRenderingAttachmentInfo	create()	Returns a new VkRenderingAttachmentInfo instance allocated with BufferUtils.
static VkRenderingAttachmentInfo.Buffer	create(int capacity)	Returns a new VkRenderingAttachmentInfo.Buffer instance allocated with BufferUtils.
static VkRenderingAttachmentInfo	create(long address)	Returns a new VkRenderingAttachmentInfo instance for the specified memory address.
static VkRenderingAttachmentInfo.Buffer	create(long address, int capacity)	Create a VkRenderingAttachmentInfo.Buffer instance at the specified memory.
static @Nullable VkRenderingAttachmentInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingAttachmentInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageLayout()
VkRenderingAttachmentInfo	imageLayout(int value)	Sets the specified value to the imageLayout field.
long	imageView()
VkRenderingAttachmentInfo	imageView(long value)	Sets the specified value to the imageView field.
int	loadOp()
VkRenderingAttachmentInfo	loadOp(int value)	Sets the specified value to the loadOp field.
static VkRenderingAttachmentInfo	malloc()	Returns a new VkRenderingAttachmentInfo instance allocated with memAlloc.
static VkRenderingAttachmentInfo.Buffer	malloc(int capacity)	Returns a new VkRenderingAttachmentInfo.Buffer instance allocated with memAlloc.
static VkRenderingAttachmentInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAttachmentInfo.Buffer instance allocated on the specified MemoryStack.
static VkRenderingAttachmentInfo	malloc(MemoryStack stack)	Returns a new VkRenderingAttachmentInfo instance allocated on the specified MemoryStack.
static VkClearValue	nclearValue(long struct)	Unsafe version of clearValue().
static void	nclearValue(long struct, VkClearValue value)	Unsafe version of clearValue.
static int	nimageLayout(long struct)	Unsafe version of imageLayout().
static void	nimageLayout(long struct, int value)	Unsafe version of imageLayout.
static long	nimageView(long struct)	Unsafe version of imageView().
static void	nimageView(long struct, long value)	Unsafe version of imageView.
static int	nloadOp(long struct)	Unsafe version of loadOp().
static void	nloadOp(long struct, int value)	Unsafe version of loadOp.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nresolveImageLayout(long struct)	Unsafe version of resolveImageLayout().
static void	nresolveImageLayout(long struct, int value)	Unsafe version of resolveImageLayout.
static long	nresolveImageView(long struct)	Unsafe version of resolveImageView().
static void	nresolveImageView(long struct, long value)	Unsafe version of resolveImageView.
static int	nresolveMode(long struct)	Unsafe version of resolveMode().
static void	nresolveMode(long struct, int value)	Unsafe version of resolveMode.
static int	nstoreOp(long struct)	Unsafe version of storeOp().
static void	nstoreOp(long struct, int value)	Unsafe version of storeOp.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkRenderingAttachmentInfo	pNext(long value)	Sets the specified value to the pNext field.
VkRenderingAttachmentInfo	pNext(VkAttachmentFeedbackLoopInfoEXT value)	Prepends the specified VkAttachmentFeedbackLoopInfoEXT value to the pNext chain.
int	resolveImageLayout()
VkRenderingAttachmentInfo	resolveImageLayout(int value)	Sets the specified value to the resolveImageLayout field.
long	resolveImageView()
VkRenderingAttachmentInfo	resolveImageView(long value)	Sets the specified value to the resolveImageView field.
int	resolveMode()
VkRenderingAttachmentInfo	resolveMode(int value)	Sets the specified value to the resolveMode field.
VkRenderingAttachmentInfo	set(int sType, long pNext, long imageView, int imageLayout, int resolveMode, long resolveImageView, int resolveImageLayout, int loadOp, int storeOp, VkClearValue clearValue)	Initializes this struct with the specified values.
VkRenderingAttachmentInfo	set(VkRenderingAttachmentInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	storeOp()
VkRenderingAttachmentInfo	storeOp(int value)	Sets the specified value to the storeOp field.
int	sType()
VkRenderingAttachmentInfo	sType(int value)	Sets the specified value to the sType field.
VkRenderingAttachmentInfo	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_ATTACHMENT_INFO value to the sType field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

IMAGEVIEW

public static final int IMAGEVIEW

The struct member offsets.

IMAGELAYOUT

public static final int IMAGELAYOUT

The struct member offsets.

RESOLVEMODE

public static final int RESOLVEMODE

The struct member offsets.

RESOLVEIMAGEVIEW

public static final int RESOLVEIMAGEVIEW

The struct member offsets.

RESOLVEIMAGELAYOUT

public static final int RESOLVEIMAGELAYOUT

The struct member offsets.

LOADOP

public static final int LOADOP

The struct member offsets.

STOREOP

public static final int STOREOP

The struct member offsets.

CLEARVALUE

public static final int CLEARVALUE

The struct member offsets.

Constructor Details

VkRenderingAttachmentInfo

public VkRenderingAttachmentInfo(ByteBuffer container)

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

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

imageView

public long imageView()

Returns:

the value of the imageView field.

imageLayout

public int imageLayout()

Returns:

the value of the imageLayout field.

resolveMode

public int resolveMode()

Returns:

the value of the resolveMode field.

resolveImageView

public long resolveImageView()

Returns:

the value of the resolveImageView field.

resolveImageLayout

public int resolveImageLayout()

Returns:

the value of the resolveImageLayout field.

loadOp

public int loadOp()

Returns:

the value of the loadOp field.

storeOp

public int storeOp()

Returns:

the value of the storeOp field.

clearValue

public VkClearValue clearValue()

Returns:

a VkClearValue view of the clearValue field.

sType

public VkRenderingAttachmentInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkRenderingAttachmentInfo sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_ATTACHMENT_INFO value to the sType field.

pNext

public VkRenderingAttachmentInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkRenderingAttachmentInfo pNext(VkAttachmentFeedbackLoopInfoEXT value)

Prepends the specified VkAttachmentFeedbackLoopInfoEXT value to the pNext chain.

imageView

public VkRenderingAttachmentInfo imageView(long value)

Sets the specified value to the imageView field.

imageLayout

public VkRenderingAttachmentInfo imageLayout(int value)

Sets the specified value to the imageLayout field.

resolveMode

public VkRenderingAttachmentInfo resolveMode(int value)

Sets the specified value to the resolveMode field.

resolveImageView

public VkRenderingAttachmentInfo resolveImageView(long value)

Sets the specified value to the resolveImageView field.

resolveImageLayout

public VkRenderingAttachmentInfo resolveImageLayout(int value)

Sets the specified value to the resolveImageLayout field.

loadOp

public VkRenderingAttachmentInfo loadOp(int value)

Sets the specified value to the loadOp field.

storeOp

public VkRenderingAttachmentInfo storeOp(int value)

Sets the specified value to the storeOp field.

clearValue

public VkRenderingAttachmentInfo clearValue(VkClearValue value)

Copies the specified VkClearValue to the clearValue field.

clearValue

public VkRenderingAttachmentInfo clearValue(Consumer<VkClearValue> consumer)

Passes the clearValue field to the specified Consumer.

set

public VkRenderingAttachmentInfo set(int sType,
 long pNext,
 long imageView,
 int imageLayout,
 int resolveMode,
 long resolveImageView,
 int resolveImageLayout,
 int loadOp,
 int storeOp,
 VkClearValue clearValue)

Initializes this struct with the specified values.

set

public VkRenderingAttachmentInfo set(VkRenderingAttachmentInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingAttachmentInfo malloc()

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

calloc

public static VkRenderingAttachmentInfo calloc()

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

create

public static VkRenderingAttachmentInfo create()

Returns a new VkRenderingAttachmentInfo instance allocated with BufferUtils.

create

public static VkRenderingAttachmentInfo create(long address)

Returns a new VkRenderingAttachmentInfo instance for the specified memory address.

createSafe

public static @Nullable VkRenderingAttachmentInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAttachmentInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingAttachmentInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderingAttachmentInfo.Buffer create(int capacity)

Returns a new VkRenderingAttachmentInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderingAttachmentInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAttachmentInfo malloc(MemoryStack stack)

Returns a new VkRenderingAttachmentInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderingAttachmentInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderingAttachmentInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nimageView

public static long nimageView(long struct)

Unsafe version of imageView().

nimageLayout

public static int nimageLayout(long struct)

Unsafe version of imageLayout().

nresolveMode

public static int nresolveMode(long struct)

Unsafe version of resolveMode().

nresolveImageView

public static long nresolveImageView(long struct)

Unsafe version of resolveImageView().

nresolveImageLayout

public static int nresolveImageLayout(long struct)

Unsafe version of resolveImageLayout().

nloadOp

public static int nloadOp(long struct)

Unsafe version of loadOp().

nstoreOp

public static int nstoreOp(long struct)

Unsafe version of storeOp().

nclearValue

public static VkClearValue nclearValue(long struct)

Unsafe version of clearValue().

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.

nimageView

public static void nimageView(long struct,
 long value)

Unsafe version of imageView.

nimageLayout

public static void nimageLayout(long struct,
 int value)

Unsafe version of imageLayout.

nresolveMode

public static void nresolveMode(long struct,
 int value)

Unsafe version of resolveMode.

nresolveImageView

public static void nresolveImageView(long struct,
 long value)

Unsafe version of resolveImageView.

nresolveImageLayout

public static void nresolveImageLayout(long struct,
 int value)

Unsafe version of resolveImageLayout.

nloadOp

public static void nloadOp(long struct,
 int value)

Unsafe version of loadOp.

nstoreOp

public static void nstoreOp(long struct,
 int value)

Unsafe version of storeOp.

nclearValue

public static void nclearValue(long struct,
 VkClearValue value)

Unsafe version of clearValue.