Package org.lwjgl.vulkan

Class VkFramebufferAttachmentsCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkFramebufferAttachmentsCreateInfo>

org.lwjgl.vulkan.VkFramebufferAttachmentsCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkFramebufferAttachmentsCreateInfoKHR

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

Structure specifying parameters of images that will be used with a framebuffer.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENTS_CREATE_INFO
• If attachmentImageInfoCount is not 0, pAttachmentImageInfos must be a valid pointer to an array of attachmentImageInfoCount valid VkFramebufferAttachmentImageInfo structures

See Also

VkFramebufferAttachmentImageInfo

Layout

 struct VkFramebufferAttachmentsCreateInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t attachmentImageInfoCount();
     VkFramebufferAttachmentImageInfo const * pAttachmentImageInfos();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkFramebufferAttachmentsCreateInfo.Buffer	An array of VkFramebufferAttachmentsCreateInfo 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	ATTACHMENTIMAGEINFOCOUNT	The struct member offsets.
static final int	PATTACHMENTIMAGEINFOS	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
VkFramebufferAttachmentsCreateInfo(ByteBuffer container)	Creates a VkFramebufferAttachmentsCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	attachmentImageInfoCount()	the number of attachments being described.
static VkFramebufferAttachmentsCreateInfo	calloc()	Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with memCalloc.
static VkFramebufferAttachmentsCreateInfo.Buffer	calloc(int capacity)	Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with memCalloc.
static VkFramebufferAttachmentsCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentsCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentsCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFramebufferAttachmentsCreateInfo	create()	Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with BufferUtils.
static VkFramebufferAttachmentsCreateInfo.Buffer	create(int capacity)	Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with BufferUtils.
static VkFramebufferAttachmentsCreateInfo	create(long address)	Returns a new VkFramebufferAttachmentsCreateInfo instance for the specified memory address.
static VkFramebufferAttachmentsCreateInfo.Buffer	create(long address, int capacity)	Create a VkFramebufferAttachmentsCreateInfo.Buffer instance at the specified memory.
static @Nullable VkFramebufferAttachmentsCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkFramebufferAttachmentsCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkFramebufferAttachmentsCreateInfo	malloc()	Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with memAlloc.
static VkFramebufferAttachmentsCreateInfo.Buffer	malloc(int capacity)	Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with memAlloc.
static VkFramebufferAttachmentsCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkFramebufferAttachmentsCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFramebufferAttachmentsCreateInfo instance allocated on the specified MemoryStack.
static int	nattachmentImageInfoCount(long struct)	Unsafe version of attachmentImageInfoCount().
static void	nattachmentImageInfoCount(long struct, int value)	Sets the specified value to the attachmentImageInfoCount field of the specified struct.
static @Nullable VkFramebufferAttachmentImageInfo.Buffer	npAttachmentImageInfos(long struct)	Unsafe version of pAttachmentImageInfos().
static void	npAttachmentImageInfos(long struct, @Nullable VkFramebufferAttachmentImageInfo.Buffer value)	Unsafe version of pAttachmentImageInfos.
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 VkFramebufferAttachmentImageInfo.Buffer	pAttachmentImageInfos()	a pointer to an array of VkFramebufferAttachmentImageInfo structures, each structure describing a number of parameters of the corresponding attachment in a render pass instance.
VkFramebufferAttachmentsCreateInfo	pAttachmentImageInfos(@Nullable VkFramebufferAttachmentImageInfo.Buffer value)	Sets the address of the specified VkFramebufferAttachmentImageInfo.Buffer to the pAttachmentImageInfos() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkFramebufferAttachmentsCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkFramebufferAttachmentsCreateInfo	set(int sType, long pNext, @Nullable VkFramebufferAttachmentImageInfo.Buffer pAttachmentImageInfos)	Initializes this struct with the specified values.
VkFramebufferAttachmentsCreateInfo	set(VkFramebufferAttachmentsCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkFramebufferAttachmentsCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkFramebufferAttachmentsCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENTS_CREATE_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.

ATTACHMENTIMAGEINFOCOUNT

public static final int ATTACHMENTIMAGEINFOCOUNT

The struct member offsets.

PATTACHMENTIMAGEINFOS

public static final int PATTACHMENTIMAGEINFOS

The struct member offsets.

Constructor Details

VkFramebufferAttachmentsCreateInfo

public VkFramebufferAttachmentsCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

attachmentImageInfoCount

public int attachmentImageInfoCount()

the number of attachments being described.

pAttachmentImageInfos

public @Nullable VkFramebufferAttachmentImageInfo.Buffer pAttachmentImageInfos()

a pointer to an array of VkFramebufferAttachmentImageInfo structures, each structure describing a number of parameters of the corresponding attachment in a render pass instance.

sType

public VkFramebufferAttachmentsCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkFramebufferAttachmentsCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENTS_CREATE_INFO value to the sType() field.

pNext

public VkFramebufferAttachmentsCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pAttachmentImageInfos

public VkFramebufferAttachmentsCreateInfo pAttachmentImageInfos(@Nullable VkFramebufferAttachmentImageInfo.Buffer value)

Sets the address of the specified VkFramebufferAttachmentImageInfo.Buffer to the pAttachmentImageInfos() field.

set

public VkFramebufferAttachmentsCreateInfo set(int sType,
 long pNext,
 @Nullable VkFramebufferAttachmentImageInfo.Buffer pAttachmentImageInfos)

Initializes this struct with the specified values.

set

public VkFramebufferAttachmentsCreateInfo set(VkFramebufferAttachmentsCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkFramebufferAttachmentsCreateInfo malloc()

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

calloc

public static VkFramebufferAttachmentsCreateInfo calloc()

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

create

public static VkFramebufferAttachmentsCreateInfo create()

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with BufferUtils.

create

public static VkFramebufferAttachmentsCreateInfo create(long address)

Returns a new VkFramebufferAttachmentsCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkFramebufferAttachmentsCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkFramebufferAttachmentsCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkFramebufferAttachmentsCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkFramebufferAttachmentsCreateInfo.Buffer create(int capacity)

Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkFramebufferAttachmentsCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nattachmentImageInfoCount

public static int nattachmentImageInfoCount(long struct)

Unsafe version of attachmentImageInfoCount().

npAttachmentImageInfos

public static @Nullable VkFramebufferAttachmentImageInfo.Buffer npAttachmentImageInfos(long struct)

Unsafe version of pAttachmentImageInfos().

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.

nattachmentImageInfoCount

public static void nattachmentImageInfoCount(long struct,
 int value)

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

npAttachmentImageInfos

public static void npAttachmentImageInfos(long struct,
 @Nullable VkFramebufferAttachmentImageInfo.Buffer value)

Unsafe version of pAttachmentImageInfos.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate