Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRenderPassAttachmentBeginInfo

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

Structure specifying images to be used as framebuffer attachments.
Valid Usage
Valid Usage (Implicit)

Layout


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

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
ATTACHMENTCOUNT

The struct member offsets.

public static final int
PATTACHMENTS

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

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

Method Summary

Modifier and TypeMethod and Description
public int
attachmentCount()

the number of attachments.

public static VkRenderPassAttachmentBeginInfo
calloc()

Returns a new VkRenderPassAttachmentBeginInfo instance allocated with memCalloc.

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

Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkRenderPassAttachmentBeginInfo instance allocated with BufferUtils.

public static VkRenderPassAttachmentBeginInfo
create(long address)

Returns a new VkRenderPassAttachmentBeginInfo instance for the specified memory address.

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

Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with BufferUtils.

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

Create a VkRenderPassAttachmentBeginInfo.Buffer instance at the specified memory.

public static VkRenderPassAttachmentBeginInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkRenderPassAttachmentBeginInfo
malloc()

Returns a new VkRenderPassAttachmentBeginInfo instance allocated with memAlloc.

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

Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkRenderPassAttachmentBeginInfo instance allocated on the specified MemoryStack.

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

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

public static int
nattachmentCount(long struct)

Unsafe version of attachmentCount.

public static void
nattachmentCount(long struct, int value)

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

public static LongBuffer
npAttachments(long struct)

Unsafe version of pAttachments.

public static void
npAttachments(long struct, LongBuffer value)

Unsafe version of pAttachments.

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 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.

public VkRenderPassAttachmentBeginInfo
pAttachments(LongBuffer value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkRenderPassAttachmentBeginInfo
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkRenderPassAttachmentBeginInfo

Returns:

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

Sets the specified value to the sType field.

public VkRenderPassAttachmentBeginInfo
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.

ATTACHMENTCOUNTback to summary
public static final int ATTACHMENTCOUNT

The struct member offsets.

PATTACHMENTSback to summary
public static final int PATTACHMENTS

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

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

attachmentCountback to summary
public int attachmentCount()

the number of attachments.

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRenderPassAttachmentBeginInfo calloc(MemoryStack stack)

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

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

Returns a new VkRenderPassAttachmentBeginInfo instance allocated with BufferUtils.

createback to summary
public static VkRenderPassAttachmentBeginInfo create(long address)

Returns a new VkRenderPassAttachmentBeginInfo instance for the specified memory address.

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

Returns a new VkRenderPassAttachmentBeginInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkRenderPassAttachmentBeginInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRenderPassAttachmentBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRenderPassAttachmentBeginInfo malloc(MemoryStack stack)

Returns a new VkRenderPassAttachmentBeginInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nattachmentCountback to summary
public static int nattachmentCount(long struct)

Unsafe version of attachmentCount.

nattachmentCountback to summary
public static void nattachmentCount(long struct, int value)

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

npAttachmentsback to summary
public static LongBuffer npAttachments(long struct)

Unsafe version of pAttachments.

Annotations
@Nullable
npAttachmentsback to summary
public static void npAttachments(long struct, LongBuffer value)

Unsafe version of pAttachments.

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.

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

Annotations
@Nullable
@NativeType:VkImageView const *
pAttachmentsback to summary
public VkRenderPassAttachmentBeginInfo pAttachments(LongBuffer value)

Sets the address of the specified LongBuffer to the pAttachments 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 VkRenderPassAttachmentBeginInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkRenderPassAttachmentBeginInfo set(int sType, long pNext, LongBuffer pAttachments)

Initializes this struct with the specified values.

setback to summary
public VkRenderPassAttachmentBeginInfo set(VkRenderPassAttachmentBeginInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkRenderPassAttachmentBeginInfo

the source struct

Returns:VkRenderPassAttachmentBeginInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_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 VkRenderPassAttachmentBeginInfo.Buffer

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

An array of VkRenderPassAttachmentBeginInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkRenderPassAttachmentBeginInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRenderPassAttachmentBeginInfo.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 VkRenderPassAttachmentBeginInfo
public LongBuffer

Returns:

a LongBuffer view of the data pointed to by the VkRenderPassAttachmentBeginInfo#pAttachments field.
pAttachments
()

public VkRenderPassAttachmentBeginInfo.Buffer
pAttachments(LongBuffer value)

Sets the address of the specified LongBuffer to the VkRenderPassAttachmentBeginInfo#pAttachments field.

public long

Returns:

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

public VkRenderPassAttachmentBeginInfo.Buffer
pNext(long value)

Sets the specified value to the VkRenderPassAttachmentBeginInfo#pNext field.

protected VkRenderPassAttachmentBeginInfo.Buffer
public int

Returns:

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

public VkRenderPassAttachmentBeginInfo.Buffer
sType(int value)

Sets the specified value to the VkRenderPassAttachmentBeginInfo#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRenderPassAttachmentBeginInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

attachmentCountback to summary
public int attachmentCount()
Returns:int

the value of the VkRenderPassAttachmentBeginInfo#attachmentCount field.

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

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

Annotations
@Override
pAttachmentsback to summary
public LongBuffer pAttachments()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkRenderPassAttachmentBeginInfo#pAttachments field.

Annotations
@Nullable
@NativeType:VkImageView const *
pAttachmentsback to summary
public VkRenderPassAttachmentBeginInfo.Buffer pAttachments(LongBuffer value)

Sets the address of the specified LongBuffer to the VkRenderPassAttachmentBeginInfo#pAttachments field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkRenderPassAttachmentBeginInfo#pNext field.

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

Sets the specified value to the VkRenderPassAttachmentBeginInfo#pNext field.

selfback to summary
protected VkRenderPassAttachmentBeginInfo.Buffer self()

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

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

the value of the VkRenderPassAttachmentBeginInfo#sType field.

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

Sets the specified value to the VkRenderPassAttachmentBeginInfo#sType field.

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

Sets the STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO value to the VkRenderPassAttachmentBeginInfo#sType field.