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
sTypemust beSTRUCTURE_TYPE_RENDER_PASS_CREATE_INFOpNextmust beNULLflagsmust be 0- If
attachmentCountis not 0,pAttachmentsmust be a pointer to an array ofattachmentCountvalidVkAttachmentDescriptionstructures pSubpassesmust be a pointer to an array ofsubpassCountvalidVkSubpassDescriptionstructures- If
dependencyCountis not 0,pDependenciesmust be a pointer to an array ofdependencyCountvalidVkSubpassDependencystructures subpassCountmust be greater than 0- If any two subpasses operate on attachments with overlapping ranges of the same
VkDeviceMemoryobject, 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
attachmentmember of any element ofpInputAttachments,pColorAttachments,pResolveAttachmentsorpDepthStencilAttachment, or the attachment indexed by any element ofpPreserveAttachmentsin any given element ofpSubpassesis bound to a range of aVkDeviceMemoryobject that overlaps with any other attachment in any subpass (including the same subpass), theVkAttachmentDescriptionstructures describing them must includeATTACHMENT_DESCRIPTION_MAY_ALIAS_BITinflags - If the
attachmentmember of any element ofpInputAttachments,pColorAttachments,pResolveAttachmentsorpDepthStencilAttachment, or any element ofpPreserveAttachmentsin any given element ofpSubpassesis notATTACHMENT_UNUSED, it must be less thanattachmentCount - The value of any element of the
pPreserveAttachmentsmember in any given element ofpSubpassesmust not beATTACHMENT_UNUSED
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_RENDER_PASS_CREATE_INFOpNext– 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 ofattachmentCountnumber ofVkAttachmentDescriptionstructures describing properties of the attachments, orNULLifattachmentCountis zerosubpassCount– the number of subpasses to create for this render passpSubpasses– points to an array ofsubpassCountnumber ofVkSubpassDescriptionstructures describing properties of the subpassesdependencyCount– the number of dependencies between pairs of subpasses, or zero indicating no dependenciespDependencies– points to an array ofdependencyCountnumber ofVkSubpassDependencystructures describing dependencies between pairs of subpasses, orNULLifdependencyCountis 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 classVkRenderPassCreateInfo.BufferAn array ofVkRenderPassCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkRenderPassCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intattachmentCount()Returns the value of theattachmentCountfield.static VkRenderPassCreateInfocalloc()Returns a newVkRenderPassCreateInfoinstance allocated withmemCalloc.static VkRenderPassCreateInfo.Buffercalloc(int capacity)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withmemCalloc.static VkRenderPassCreateInfocallocStack()Returns a newVkRenderPassCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRenderPassCreateInfo.BuffercallocStack(int capacity)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRenderPassCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderPassCreateInfocallocStack(MemoryStack stack)Returns a newVkRenderPassCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderPassCreateInfocreate()Returns a newVkRenderPassCreateInfoinstance allocated withBufferUtils.static VkRenderPassCreateInfo.Buffercreate(int capacity)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withBufferUtils.static VkRenderPassCreateInfocreate(long address)Returns a newVkRenderPassCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkRenderPassCreateInfo.Buffercreate(long address, int capacity)Create aVkRenderPassCreateInfo.Bufferinstance at the specified memory.intdependencyCount()Returns the value of thedependencyCountfield.intflags()Returns the value of theflagsfield.VkRenderPassCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkRenderPassCreateInfomalloc()Returns a newVkRenderPassCreateInfoinstance allocated withmemAlloc.static VkRenderPassCreateInfo.Buffermalloc(int capacity)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withmemAlloc.static VkRenderPassCreateInfomallocStack()Returns a newVkRenderPassCreateInfoinstance allocated on the thread-localMemoryStack.static VkRenderPassCreateInfo.BuffermallocStack(int capacity)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkRenderPassCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkRenderPassCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkRenderPassCreateInfomallocStack(MemoryStack stack)Returns a newVkRenderPassCreateInfoinstance allocated on the specifiedMemoryStack.VkRenderPassCreateInfonset(long struct)Unsafe version ofset.VkAttachmentDescription.BufferpAttachments()Returns aVkAttachmentDescription.Bufferview of the struct array pointed to by thepAttachmentsfield.VkRenderPassCreateInfopAttachments(VkAttachmentDescription.Buffer value)Sets the address of the specifiedVkAttachmentDescription.Bufferto thepAttachmentsfield.VkSubpassDependency.BufferpDependencies()Returns aVkSubpassDependency.Bufferview of the struct array pointed to by thepDependenciesfield.VkRenderPassCreateInfopDependencies(VkSubpassDependency.Buffer value)Sets the address of the specifiedVkSubpassDependency.Bufferto thepDependenciesfield.longpNext()Returns the value of thepNextfield.VkRenderPassCreateInfopNext(long value)Sets the specified value to thepNextfield.VkSubpassDescription.BufferpSubpasses()Returns aVkSubpassDescription.Bufferview of the struct array pointed to by thepSubpassesfield.VkRenderPassCreateInfopSubpasses(VkSubpassDescription.Buffer value)Sets the address of the specifiedVkSubpassDescription.Bufferto thepSubpassesfield.VkRenderPassCreateInfoset(int sType, long pNext, int flags, VkAttachmentDescription.Buffer pAttachments, VkSubpassDescription.Buffer pSubpasses, VkSubpassDependency.Buffer pDependencies)Initializes this struct with the specified values.VkRenderPassCreateInfoset(VkRenderPassCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkRenderPassCreateInfosType(int value)Sets the specified value to thesTypefield.intsubpassCount()Returns the value of thesubpassCountfield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(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 aVkRenderPassCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
attachmentCount
public int attachmentCount()
Returns the value of theattachmentCountfield.
-
pAttachments
public VkAttachmentDescription.Buffer pAttachments()
Returns aVkAttachmentDescription.Bufferview of the struct array pointed to by thepAttachmentsfield.
-
subpassCount
public int subpassCount()
Returns the value of thesubpassCountfield.
-
pSubpasses
public VkSubpassDescription.Buffer pSubpasses()
Returns aVkSubpassDescription.Bufferview of the struct array pointed to by thepSubpassesfield.
-
dependencyCount
public int dependencyCount()
Returns the value of thedependencyCountfield.
-
pDependencies
public VkSubpassDependency.Buffer pDependencies()
Returns aVkSubpassDependency.Bufferview of the struct array pointed to by thepDependenciesfield.
-
sType
public VkRenderPassCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkRenderPassCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkRenderPassCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
pAttachments
public VkRenderPassCreateInfo pAttachments(VkAttachmentDescription.Buffer value)
Sets the address of the specifiedVkAttachmentDescription.Bufferto thepAttachmentsfield.
-
pSubpasses
public VkRenderPassCreateInfo pSubpasses(VkSubpassDescription.Buffer value)
Sets the address of the specifiedVkSubpassDescription.Bufferto thepSubpassesfield.
-
pDependencies
public VkRenderPassCreateInfo pDependencies(VkSubpassDependency.Buffer value)
Sets the address of the specifiedVkSubpassDependency.Bufferto thepDependenciesfield.
-
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 newVkRenderPassCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRenderPassCreateInfo calloc()
Returns a newVkRenderPassCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRenderPassCreateInfo create()
Returns a newVkRenderPassCreateInfoinstance allocated withBufferUtils.
-
create
public static VkRenderPassCreateInfo create(long address)
Returns a newVkRenderPassCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkRenderPassCreateInfo.Buffer malloc(int capacity)
Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRenderPassCreateInfo.Buffer calloc(int capacity)
Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderPassCreateInfo.Buffer create(int capacity)
Returns a newVkRenderPassCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderPassCreateInfo.Buffer create(long address, int capacity)
Create aVkRenderPassCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkRenderPassCreateInfo mallocStack()
Returns a newVkRenderPassCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkRenderPassCreateInfo callocStack()
Returns a newVkRenderPassCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkRenderPassCreateInfo mallocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkRenderPassCreateInfo callocStack(MemoryStack stack)
Returns a newVkRenderPassCreateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkRenderPassCreateInfo.Buffer callocStack(int capacity)
Returns a newVkRenderPassCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkRenderPassCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassCreateInfo.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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
-
-