Package org.lwjgl.vulkan
Class VkRenderPassCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRenderPassCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkRenderPassCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a render pass should be created.
Valid Usage
sType
must beSTRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
pNext
must beNULL
flags
must be 0- If
attachmentCount
is not 0,pAttachments
must be a pointer to an array ofattachmentCount
validVkAttachmentDescription
structures pSubpasses
must be a pointer to an array ofsubpassCount
validVkSubpassDescription
structures- If
dependencyCount
is not 0,pDependencies
must be a pointer to an array ofdependencyCount
validVkSubpassDependency
structures subpassCount
must be greater than 0- If any two subpasses operate on attachments with overlapping ranges of the same
VkDeviceMemory
object, and at least one subpass writes to that area ofVkDeviceMemory
, a subpass dependency must be included (either directly or via some intermediate subpasses) between them - If the
attachment
member of any element ofpInputAttachments
,pColorAttachments
,pResolveAttachments
orpDepthStencilAttachment
, or the attachment indexed by any element ofpPreserveAttachments
in any given element ofpSubpasses
is bound to a range of aVkDeviceMemory
object that overlaps with any other attachment in any subpass (including the same subpass), theVkAttachmentDescription
structures describing them must includeATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT
inflags
- If the
attachment
member of any element ofpInputAttachments
,pColorAttachments
,pResolveAttachments
orpDepthStencilAttachment
, or any element ofpPreserveAttachments
in any given element ofpSubpasses
is notATTACHMENT_UNUSED
, it must be less thanattachmentCount
- The value of any element of the
pPreserveAttachments
member in any given element ofpSubpasses
must not beATTACHMENT_UNUSED
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future useattachmentCount
– the number of attachments used by this render pass, or zero indicating no attachmentspAttachments
– points to an array ofattachmentCount
number ofVkAttachmentDescription
structures describing properties of the attachments, orNULL
ifattachmentCount
is zerosubpassCount
– the number of subpasses to create for this render passpSubpasses
– points to an array ofsubpassCount
number ofVkSubpassDescription
structures describing properties of the subpassesdependencyCount
– the number of dependencies between pairs of subpasses, or zero indicating no dependenciespDependencies
– points to an array ofdependencyCount
number ofVkSubpassDependency
structures describing dependencies between pairs of subpasses, orNULL
ifdependencyCount
is zero
Layout
struct VkRenderPassCreateInfo { VkStructureType sType; const void * pNext; VkRenderPassCreateFlags flags; uint32_t attachmentCount; const VkAttachmentDescription * pAttachments; uint32_t subpassCount; const VkSubpassDescription * pSubpasses; uint32_t dependencyCount; const VkSubpassDependency * pDependencies; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkRenderPassCreateInfo.Buffer
An array ofVkRenderPassCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkRenderPassCreateInfo(java.nio.ByteBuffer container)
Creates aVkRenderPassCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
attachmentCount()
Returns the value of theattachmentCount
field.static VkRenderPassCreateInfo
calloc()
Returns a newVkRenderPassCreateInfo
instance allocated withmemCalloc
.static VkRenderPassCreateInfo.Buffer
calloc(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withmemCalloc
.static VkRenderPassCreateInfo
callocStack()
Returns a newVkRenderPassCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassCreateInfo
callocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassCreateInfo
create()
Returns a newVkRenderPassCreateInfo
instance allocated withBufferUtils
.static VkRenderPassCreateInfo.Buffer
create(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withBufferUtils
.static VkRenderPassCreateInfo
create(long address)
Returns a newVkRenderPassCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkRenderPassCreateInfo.Buffer
create(long address, int capacity)
Create aVkRenderPassCreateInfo.Buffer
instance at the specified memory.int
dependencyCount()
Returns the value of thedependencyCount
field.int
flags()
Returns the value of theflags
field.VkRenderPassCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkRenderPassCreateInfo
malloc()
Returns a newVkRenderPassCreateInfo
instance allocated withmemAlloc
.static VkRenderPassCreateInfo.Buffer
malloc(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withmemAlloc
.static VkRenderPassCreateInfo
mallocStack()
Returns a newVkRenderPassCreateInfo
instance allocated on the thread-localMemoryStack
.static VkRenderPassCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkRenderPassCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkRenderPassCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfo
instance allocated on the specifiedMemoryStack
.VkRenderPassCreateInfo
nset(long struct)
Unsafe version ofset
.VkAttachmentDescription.Buffer
pAttachments()
Returns aVkAttachmentDescription.Buffer
view of the struct array pointed to by thepAttachments
field.VkRenderPassCreateInfo
pAttachments(VkAttachmentDescription.Buffer value)
Sets the address of the specifiedVkAttachmentDescription.Buffer
to thepAttachments
field.VkSubpassDependency.Buffer
pDependencies()
Returns aVkSubpassDependency.Buffer
view of the struct array pointed to by thepDependencies
field.VkRenderPassCreateInfo
pDependencies(VkSubpassDependency.Buffer value)
Sets the address of the specifiedVkSubpassDependency.Buffer
to thepDependencies
field.long
pNext()
Returns the value of thepNext
field.VkRenderPassCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkSubpassDescription.Buffer
pSubpasses()
Returns aVkSubpassDescription.Buffer
view of the struct array pointed to by thepSubpasses
field.VkRenderPassCreateInfo
pSubpasses(VkSubpassDescription.Buffer value)
Sets the address of the specifiedVkSubpassDescription.Buffer
to thepSubpasses
field.VkRenderPassCreateInfo
set(int sType, long pNext, int flags, VkAttachmentDescription.Buffer pAttachments, VkSubpassDescription.Buffer pSubpasses, VkSubpassDependency.Buffer pDependencies)
Initializes this struct with the specified values.VkRenderPassCreateInfo
set(VkRenderPassCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkRenderPassCreateInfo
sType(int value)
Sets the specified value to thesType
field.int
subpassCount()
Returns the value of thesubpassCount
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
CallsVkRenderPassCreateInfo.validate(long)
for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkRenderPassCreateInfo
public VkRenderPassCreateInfo(java.nio.ByteBuffer container)
Creates aVkRenderPassCreateInfo
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
attachmentCount
public int attachmentCount()
Returns the value of theattachmentCount
field.
-
pAttachments
public VkAttachmentDescription.Buffer pAttachments()
Returns aVkAttachmentDescription.Buffer
view of the struct array pointed to by thepAttachments
field.
-
subpassCount
public int subpassCount()
Returns the value of thesubpassCount
field.
-
pSubpasses
public VkSubpassDescription.Buffer pSubpasses()
Returns aVkSubpassDescription.Buffer
view of the struct array pointed to by thepSubpasses
field.
-
dependencyCount
public int dependencyCount()
Returns the value of thedependencyCount
field.
-
pDependencies
public VkSubpassDependency.Buffer pDependencies()
Returns aVkSubpassDependency.Buffer
view of the struct array pointed to by thepDependencies
field.
-
sType
public VkRenderPassCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkRenderPassCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkRenderPassCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
pAttachments
public VkRenderPassCreateInfo pAttachments(VkAttachmentDescription.Buffer value)
Sets the address of the specifiedVkAttachmentDescription.Buffer
to thepAttachments
field.
-
pSubpasses
public VkRenderPassCreateInfo pSubpasses(VkSubpassDescription.Buffer value)
Sets the address of the specifiedVkSubpassDescription.Buffer
to thepSubpasses
field.
-
pDependencies
public VkRenderPassCreateInfo pDependencies(VkSubpassDependency.Buffer value)
Sets the address of the specifiedVkSubpassDependency.Buffer
to thepDependencies
field.
-
set
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.
-
nset
public VkRenderPassCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkRenderPassCreateInfo set(VkRenderPassCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkRenderPassCreateInfo malloc()
Returns a newVkRenderPassCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkRenderPassCreateInfo calloc()
Returns a newVkRenderPassCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkRenderPassCreateInfo create()
Returns a newVkRenderPassCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkRenderPassCreateInfo create(long address)
Returns a newVkRenderPassCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkRenderPassCreateInfo.Buffer malloc(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkRenderPassCreateInfo.Buffer calloc(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassCreateInfo.Buffer create(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassCreateInfo.Buffer create(long address, int capacity)
Create aVkRenderPassCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkRenderPassCreateInfo mallocStack()
Returns a newVkRenderPassCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkRenderPassCreateInfo callocStack()
Returns a newVkRenderPassCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkRenderPassCreateInfo mallocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRenderPassCreateInfo callocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkRenderPassCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkRenderPassCreateInfo.Buffer callocStack(int capacity)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkRenderPassCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkRenderPassCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
CallsVkRenderPassCreateInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-