Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFramebufferAttachmentsCreateInfo

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

Structure specifying parameters of images that will be used with a framebuffer.
Valid Usage (Implicit)
See Also

VkFramebufferAttachmentImageInfo

Layout


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

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
ATTACHMENTIMAGEINFOCOUNT

The struct member offsets.

public static final int
PATTACHMENTIMAGEINFOS

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
public
VkFramebufferAttachmentsCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
attachmentImageInfoCount()

the number of attachments being described.

public static VkFramebufferAttachmentsCreateInfo
calloc()

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with memCalloc.

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

Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with BufferUtils.

public static VkFramebufferAttachmentsCreateInfo
create(long address)

Returns a new VkFramebufferAttachmentsCreateInfo instance for the specified memory address.

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

Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkFramebufferAttachmentsCreateInfo.Buffer instance at the specified memory.

public static VkFramebufferAttachmentsCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkFramebufferAttachmentsCreateInfo
malloc()

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with memAlloc.

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

Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated on the specified MemoryStack.

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

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

public static int
nattachmentImageInfoCount(long struct)

Unsafe version of attachmentImageInfoCount.

public static void
nattachmentImageInfoCount(long struct, int value)

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

public static VkFramebufferAttachmentImageInfo.Buffer
npAttachmentImageInfos(long struct)

Unsafe version of pAttachmentImageInfos.

public static void
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 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.

public VkFramebufferAttachmentsCreateInfo
public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkFramebufferAttachmentsCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkFramebufferAttachmentsCreateInfo

Returns:

this struct
set
(VkFramebufferAttachmentsCreateInfo
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 VkFramebufferAttachmentsCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkFramebufferAttachmentsCreateInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

ATTACHMENTIMAGEINFOCOUNTback to summary
public static final int ATTACHMENTIMAGEINFOCOUNT

The struct member offsets.

PATTACHMENTIMAGEINFOSback to summary
public static final int PATTACHMENTIMAGEINFOS

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

VkFramebufferAttachmentsCreateInfoback to summary
protected VkFramebufferAttachmentsCreateInfo(long address, ByteBuffer container)
VkFramebufferAttachmentsCreateInfoback to summary
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 Detail

attachmentImageInfoCountback to summary
public int attachmentImageInfoCount()

the number of attachments being described.

Annotations
@NativeType:uint32_t
callocback to summary
public static VkFramebufferAttachmentsCreateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFramebufferAttachmentsCreateInfo calloc(MemoryStack stack)

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

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

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkFramebufferAttachmentsCreateInfo create(long address)

Returns a new VkFramebufferAttachmentsCreateInfo instance for the specified memory address.

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

Returns a new VkFramebufferAttachmentsCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkFramebufferAttachmentsCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFramebufferAttachmentsCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkFramebufferAttachmentsCreateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFramebufferAttachmentsCreateInfo malloc(MemoryStack stack)

Returns a new VkFramebufferAttachmentsCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nattachmentImageInfoCountback to summary
public static int nattachmentImageInfoCount(long struct)

Unsafe version of attachmentImageInfoCount.

nattachmentImageInfoCountback to summary
public static void nattachmentImageInfoCount(long struct, int value)

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

npAttachmentImageInfosback to summary
public static VkFramebufferAttachmentImageInfo.Buffer npAttachmentImageInfos(long struct)

Unsafe version of pAttachmentImageInfos.

Annotations
@Nullable
npAttachmentImageInfosback to summary
public static void npAttachmentImageInfos(long struct, VkFramebufferAttachmentImageInfo.Buffer value)

Unsafe version of pAttachmentImageInfos.

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.

pAttachmentImageInfosback to summary
public 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.

Annotations
@Nullable
@NativeType:VkFramebufferAttachmentImageInfo const *
pAttachmentImageInfosback to summary
public VkFramebufferAttachmentsCreateInfo pAttachmentImageInfos(VkFramebufferAttachmentImageInfo.Buffer value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkFramebufferAttachmentsCreateInfo set(int sType, long pNext, VkFramebufferAttachmentImageInfo.Buffer pAttachmentImageInfos)

Initializes this struct with the specified values.

setback to summary
public VkFramebufferAttachmentsCreateInfo set(VkFramebufferAttachmentsCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkFramebufferAttachmentsCreateInfo

the source struct

Returns:VkFramebufferAttachmentsCreateInfo

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 VkFramebufferAttachmentsCreateInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENTS_CREATE_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkFramebufferAttachmentsCreateInfo.Buffer

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

An array of VkFramebufferAttachmentsCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkFramebufferAttachmentsCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkFramebufferAttachmentsCreateInfo.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
protected VkFramebufferAttachmentsCreateInfo
public VkFramebufferAttachmentImageInfo.Buffer
public VkFramebufferAttachmentsCreateInfo.Buffer
public long

Returns:

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

public VkFramebufferAttachmentsCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkFramebufferAttachmentsCreateInfo#pNext field.

protected VkFramebufferAttachmentsCreateInfo.Buffer
public int

Returns:

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

public VkFramebufferAttachmentsCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkFramebufferAttachmentsCreateInfo#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFramebufferAttachmentsCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkFramebufferAttachmentsCreateInfo.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 VkFramebufferAttachmentsCreateInfo#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

attachmentImageInfoCountback to summary
public int attachmentImageInfoCount()
Returns:int

the value of the VkFramebufferAttachmentsCreateInfo#attachmentImageInfoCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkFramebufferAttachmentsCreateInfo getElementFactory()

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

Annotations
@Override
pAttachmentImageInfosback to summary
public VkFramebufferAttachmentImageInfo.Buffer pAttachmentImageInfos()
Returns:VkFramebufferAttachmentImageInfo.Buffer

a VkFramebufferAttachmentImageInfo.Buffer view of the struct array pointed to by the VkFramebufferAttachmentsCreateInfo#pAttachmentImageInfos field.

Annotations
@Nullable
@NativeType:VkFramebufferAttachmentImageInfo const *
pAttachmentImageInfosback to summary
public VkFramebufferAttachmentsCreateInfo.Buffer pAttachmentImageInfos(VkFramebufferAttachmentImageInfo.Buffer value)

Sets the address of the specified VkFramebufferAttachmentImageInfo.Buffer to the VkFramebufferAttachmentsCreateInfo#pAttachmentImageInfos field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkFramebufferAttachmentsCreateInfo#pNext field.

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

Sets the specified value to the VkFramebufferAttachmentsCreateInfo#pNext field.

selfback to summary
protected VkFramebufferAttachmentsCreateInfo.Buffer self()

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

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

the value of the VkFramebufferAttachmentsCreateInfo#sType field.

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

Sets the specified value to the VkFramebufferAttachmentsCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENTS_CREATE_INFO value to the VkFramebufferAttachmentsCreateInfo#sType field.