Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRenderPassCreateInfo

extends Struct<VkRenderPassCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of a newly created render pass.
Description
Note

Care should be taken to avoid a data race here; if any subpasses access attachments with overlapping memory locations, and one of those accesses is a write, a subpass dependency needs to be included between them.

Valid Usage
Valid Usage (Implicit)
See Also

VkAttachmentDescription, VkSubpassDependency, VkSubpassDescription, CreateRenderPass

Layout


struct VkRenderPassCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkRenderPassCreateFlags flags;
    uint32_t attachmentCount;
    VkAttachmentDescription const * pAttachments;
    uint32_t subpassCount;
    VkSubpassDescription const * pSubpasses;
    uint32_t dependencyCount;
    VkSubpassDependency const * pDependencies;
}

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
DEPENDENCYCOUNT

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PATTACHMENTS

The struct member offsets.

public static final int
PDEPENDENCIES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSUBPASSES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SUBPASSCOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkRenderPassCreateInfo(long address, ByteBuffer container)

public
VkRenderPassCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
attachmentCount()

the number of attachments used by this render pass.

public static VkRenderPassCreateInfo
calloc()

Returns a new VkRenderPassCreateInfo instance allocated with memCalloc.

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

Returns a new VkRenderPassCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkRenderPassCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkRenderPassCreateInfo
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 VkRenderPassCreateInfo
create()

Returns a new VkRenderPassCreateInfo instance allocated with BufferUtils.

public static VkRenderPassCreateInfo
create(long address)

Returns a new VkRenderPassCreateInfo instance for the specified memory address.

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

Returns a new VkRenderPassCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkRenderPassCreateInfo.Buffer instance at the specified memory.

public static VkRenderPassCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
dependencyCount()

the number of memory dependencies between pairs of subpasses.

public int
flags()

a bitmask of VkRenderPassCreateFlagBits

public VkRenderPassCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VkRenderPassCreateInfo
malloc()

Returns a new VkRenderPassCreateInfo instance allocated with memAlloc.

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

Returns a new VkRenderPassCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkRenderPassCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkRenderPassCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkRenderPassCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
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 int
ndependencyCount(long struct)

Unsafe version of dependencyCount.

public static void
ndependencyCount(long struct, int value)

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static VkAttachmentDescription.Buffer
npAttachments(long struct)

Unsafe version of pAttachments.

public static void
npAttachments(long struct, VkAttachmentDescription.Buffer value)

Unsafe version of pAttachments.

public static VkSubpassDependency.Buffer
npDependencies(long struct)

Unsafe version of pDependencies.

public static void
npDependencies(long struct, VkSubpassDependency.Buffer value)

Unsafe version of pDependencies.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkSubpassDescription.Buffer
npSubpasses(long struct)

Unsafe version of pSubpasses.

public static void
npSubpasses(long struct, VkSubpassDescription.Buffer value)

Unsafe version of pSubpasses.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nsubpassCount(long struct)

Unsafe version of subpassCount.

public static void
nsubpassCount(long struct, int value)

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

public VkAttachmentDescription.Buffer
pAttachments()

a pointer to an array of attachmentCount VkAttachmentDescription structures describing the attachments used by the render pass.

public VkRenderPassCreateInfo
pAttachments(VkAttachmentDescription.Buffer value)

Sets the address of the specified VkAttachmentDescription.Buffer to the pAttachments field.

public VkSubpassDependency.Buffer
pDependencies()

a pointer to an array of dependencyCount VkSubpassDependency structures describing dependencies between pairs of subpasses.

public VkRenderPassCreateInfo
pDependencies(VkSubpassDependency.Buffer value)

Sets the address of the specified VkSubpassDependency.Buffer to the pDependencies field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkRenderPassCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkRenderPassCreateInfo
public VkRenderPassCreateInfo
public VkRenderPassCreateInfo
public VkRenderPassCreateInfo
pNext(VkRenderPassMultiviewCreateInfo value)

Prepends the specified VkRenderPassMultiviewCreateInfo value to the pNext chain.

public VkRenderPassCreateInfo
pNext(VkRenderPassMultiviewCreateInfoKHR value)

Prepends the specified VkRenderPassMultiviewCreateInfoKHR value to the pNext chain.

public VkSubpassDescription.Buffer
pSubpasses()

a pointer to an array of subpassCount VkSubpassDescription structures describing each subpass.

public VkRenderPassCreateInfo
pSubpasses(VkSubpassDescription.Buffer value)

Sets the address of the specified VkSubpassDescription.Buffer to the pSubpasses field.

public VkRenderPassCreateInfo
set(int sType, long pNext, int flags, VkAttachmentDescription.Buffer pAttachments, VkSubpassDescription.Buffer pSubpasses, VkSubpassDependency.Buffer pDependencies)

Initializes this struct with the specified values.

public VkRenderPassCreateInfo

Returns:

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

Sets the specified value to the sType field.

public VkRenderPassCreateInfo
public int
subpassCount()

the number of subpasses to create.

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