Package org.lwjgl.vulkan

Class VkRenderPassAttachmentBeginInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassAttachmentBeginInfo>

org.lwjgl.vulkan.VkRenderPassAttachmentBeginInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkRenderPassAttachmentBeginInfoKHR

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

Structure specifying images to be used as framebuffer attachments.

Valid Usage

• Each element of pAttachments must only specify a single mip level
• Each element of pAttachments must have been created with the identity swizzle
• Each element of pAttachments must have been created with VkImageViewCreateInfo::viewType not equal to IMAGE_VIEW_TYPE_3D
• If multisampled-render-to-single-sampled is enabled for any subpass, all element of pAttachments which have a sample count equal to SAMPLE_COUNT_1_BIT must have a format that supports the sample count specified in VkMultisampledRenderToSingleSampledInfoEXT::rasterizationSamples

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO
• If attachmentCount is not 0, pAttachments must be a valid pointer to an array of attachmentCount valid VkImageView handles

Layout

 struct VkRenderPassAttachmentBeginInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t attachmentCount();
     VkImageView const * pAttachments();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderPassAttachmentBeginInfo.Buffer	An array of VkRenderPassAttachmentBeginInfo 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	ATTACHMENTCOUNT	The struct member offsets.
static final int	PATTACHMENTS	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	attachmentCount()	the number of attachments.
static VkRenderPassAttachmentBeginInfo	calloc()	Returns a new VkRenderPassAttachmentBeginInfo instance allocated with memCalloc.
static VkRenderPassAttachmentBeginInfo.Buffer	calloc(int capacity)	Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with memCalloc.
static VkRenderPassAttachmentBeginInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassAttachmentBeginInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassAttachmentBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassAttachmentBeginInfo	create()	Returns a new VkRenderPassAttachmentBeginInfo instance allocated with BufferUtils.
static VkRenderPassAttachmentBeginInfo.Buffer	create(int capacity)	Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with BufferUtils.
static VkRenderPassAttachmentBeginInfo	create(long address)	Returns a new VkRenderPassAttachmentBeginInfo instance for the specified memory address.
static VkRenderPassAttachmentBeginInfo.Buffer	create(long address, int capacity)	Create a VkRenderPassAttachmentBeginInfo.Buffer instance at the specified memory.
static @Nullable VkRenderPassAttachmentBeginInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderPassAttachmentBeginInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderPassAttachmentBeginInfo	malloc()	Returns a new VkRenderPassAttachmentBeginInfo instance allocated with memAlloc.
static VkRenderPassAttachmentBeginInfo.Buffer	malloc(int capacity)	Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with memAlloc.
static VkRenderPassAttachmentBeginInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassAttachmentBeginInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassAttachmentBeginInfo instance allocated on the specified MemoryStack.
static int	nattachmentCount(long struct)	Unsafe version of attachmentCount().
static void	nattachmentCount(long struct, int value)	Sets the specified value to the attachmentCount field of the specified struct.
static @Nullable LongBuffer	npAttachments(long struct)	Unsafe version of pAttachments.
static void	npAttachments(long struct, @Nullable LongBuffer value)	Unsafe version of pAttachments.
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.
@Nullable LongBuffer	pAttachments()	a pointer to an array of VkImageView handles, each of which will be used as the corresponding attachment in the render pass instance.
VkRenderPassAttachmentBeginInfo	pAttachments(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pAttachments() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRenderPassAttachmentBeginInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderPassAttachmentBeginInfo	set(int sType, long pNext, @Nullable LongBuffer pAttachments)	Initializes this struct with the specified values.
VkRenderPassAttachmentBeginInfo	set(VkRenderPassAttachmentBeginInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassAttachmentBeginInfo	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassAttachmentBeginInfo	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

ATTACHMENTCOUNT

public static final int ATTACHMENTCOUNT

The struct member offsets.

PATTACHMENTS

public static final int PATTACHMENTS

The struct member offsets.

Constructor Details

VkRenderPassAttachmentBeginInfo

public VkRenderPassAttachmentBeginInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

attachmentCount

public int attachmentCount()

the number of attachments.

pAttachments

public @Nullable LongBuffer pAttachments()

a pointer to an array of VkImageView handles, each of which will be used as the corresponding attachment in the render pass instance.

sType

public VkRenderPassAttachmentBeginInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassAttachmentBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO value to the sType() field.

pNext

public VkRenderPassAttachmentBeginInfo pNext(long value)

Sets the specified value to the pNext() field.

pAttachments

public VkRenderPassAttachmentBeginInfo pAttachments(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pAttachments() field.

set

public VkRenderPassAttachmentBeginInfo set(int sType,
 long pNext,
 @Nullable LongBuffer pAttachments)

Initializes this struct with the specified values.

set

public VkRenderPassAttachmentBeginInfo set(VkRenderPassAttachmentBeginInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassAttachmentBeginInfo malloc()

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

calloc

public static VkRenderPassAttachmentBeginInfo calloc()

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

create

public static VkRenderPassAttachmentBeginInfo create()

Returns a new VkRenderPassAttachmentBeginInfo instance allocated with BufferUtils.

create

public static VkRenderPassAttachmentBeginInfo create(long address)

Returns a new VkRenderPassAttachmentBeginInfo instance for the specified memory address.

createSafe

public static @Nullable VkRenderPassAttachmentBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassAttachmentBeginInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassAttachmentBeginInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassAttachmentBeginInfo.Buffer create(int capacity)

Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderPassAttachmentBeginInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkRenderPassAttachmentBeginInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nattachmentCount

public static int nattachmentCount(long struct)

Unsafe version of attachmentCount().

npAttachments

public static @Nullable LongBuffer npAttachments(long struct)

Unsafe version of pAttachments.

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.

nattachmentCount

public static void nattachmentCount(long struct,
 int value)

Sets the specified value to the attachmentCount field of the specified struct.

npAttachments

public static void npAttachments(long struct,
 @Nullable LongBuffer value)

Unsafe version of pAttachments.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate