Class VkRenderingInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRenderingInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkRenderingInfoKHR
public class VkRenderingInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying render pass instance begin info.Description
If
viewMaskis not 0, multiview is enabled.If there is an instance of
VkDeviceGroupRenderPassBeginInfoincluded in thepNextchain and itsdeviceCountmember is not 0, thenrenderAreais ignored, and the render area is defined per-device by that structure.Each element of the
pColorAttachmentsarray corresponds to an output location in the shader, i.e. if the shader declares an output variable decorated with aLocationvalue of X, then it uses the attachment provided inpColorAttachments[X]. If theimageViewmember of any element ofpColorAttachmentsisNULL_HANDLE, writes to the corresponding location by a fragment are discarded.Valid Usage
- If
viewMaskis 0,layerCountmust not be 0 - If neither the
VK_AMD_mixed_attachment_samplesnor theVK_NV_framebuffer_mixed_samplesextensions are enabled,imageViewmembers ofpDepthAttachment,pStencilAttachment, and elements ofpColorAttachmentsthat are notNULL_HANDLEmust have been created with the samesampleCount - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0,renderArea.offset.xmust be greater than or equal to 0 - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0,renderArea.offset.ymust be greater than or equal to 0 - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0, the width of theimageViewmember of any element ofpColorAttachments,pDepthAttachment, orpStencilAttachmentthat is notNULL_HANDLEmust be greater than or equal torenderArea.offset.x + renderArea.extent.width - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0, the height of theimageViewmember of any element ofpColorAttachments,pDepthAttachment, orpStencilAttachmentthat is notNULL_HANDLEmust be greater than or equal torenderArea.offset.y + renderArea.extent.height - If the
pNextchain containsVkDeviceGroupRenderPassBeginInfo, the width of theimageViewmember of any element ofpColorAttachments,pDepthAttachment, orpStencilAttachmentthat is notNULL_HANDLEmust be greater than or equal to the sum of theoffset.xandextent.widthmembers of each element ofpDeviceRenderAreas - If the
pNextchain containsVkDeviceGroupRenderPassBeginInfo, the height of theimageViewmember of any element ofpColorAttachments,pDepthAttachment, orpStencilAttachmentthat is notNULL_HANDLEmust be greater than or equal to the sum of theoffset.yandextent.heightmembers of each element ofpDeviceRenderAreas - If neither
pDepthAttachmentorpStencilAttachmentareNULLand theimageViewmember of either structure is notNULL_HANDLE, theimageViewmember of each structure must be the same - If neither
pDepthAttachmentorpStencilAttachmentareNULL, and theresolveModemember of each is notRESOLVE_MODE_NONE, theresolveImageViewmember of each structure must be the same - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, thatimageViewmust have been created withIMAGE_USAGE_COLOR_ATTACHMENT_BIT - If
pDepthAttachmentis notNULLandpDepthAttachment\u2192imageViewis notNULL_HANDLE,pDepthAttachment\u2192imageViewmust have been created with a format that includes a depth aspect - If
pDepthAttachmentis notNULLandpDepthAttachment\u2192imageViewis notNULL_HANDLE,pDepthAttachment\u2192imageViewmust have been created withIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT - If
pStencilAttachmentis notNULLandpStencilAttachment\u2192imageViewis notNULL_HANDLE,pStencilAttachment\u2192imageViewmust have been created with a format that includes a stencil aspect - If
pStencilAttachmentis notNULLandpStencilAttachment\u2192imageViewis notNULL_HANDLE,pStencilAttachment\u2192imageViewmust have been created with a stencil usage includingIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, thelayoutmember of that element ofpColorAttachmentsmust not beIMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMALorIMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, if theresolveModemember of that element ofpColorAttachmentsis notRESOLVE_MODE_NONE, itsresolveImageLayoutmember must not beIMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMALorIMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL - If
pDepthAttachmentis notNULLandpDepthAttachment\u2192imageViewis notNULL_HANDLE,pDepthAttachment\u2192layoutmust not beIMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL - If
pDepthAttachmentis notNULL,pDepthAttachment\u2192imageViewis notNULL_HANDLE, andpDepthAttachment\u2192resolveModeis notRESOLVE_MODE_NONE,pDepthAttachment\u2192resolveImageLayoutmust not beIMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL - If
pStencilAttachmentis notNULLandpStencilAttachment\u2192imageViewis notNULL_HANDLE,pStencilAttachment\u2192layoutmust not beIMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL - If
pStencilAttachmentis notNULL,pStencilAttachment\u2192imageViewis notNULL_HANDLE, andpStencilAttachment\u2192resolveModeis notRESOLVE_MODE_NONE,pStencilAttachment\u2192resolveImageLayoutmust not beIMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, thelayoutmember of that element ofpColorAttachmentsmust not beIMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMALorIMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, if theresolveModemember of that element ofpColorAttachmentsis notRESOLVE_MODE_NONE, itsresolveImageLayoutmember must not beIMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMALorIMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL - If
pDepthAttachmentis notNULL,pDepthAttachment\u2192imageViewis notNULL_HANDLE, andpDepthAttachment\u2192resolveModeis notRESOLVE_MODE_NONE,pDepthAttachment\u2192resolveImageLayoutmust not beIMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL - If
pStencilAttachmentis notNULL,pStencilAttachment\u2192imageViewis notNULL_HANDLE, andpStencilAttachment\u2192resolveModeis notRESOLVE_MODE_NONE,pStencilAttachment\u2192resolveImageLayoutmust not beIMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, thelayoutmember of that element ofpColorAttachmentsmust not beIMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL,IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL,IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, orIMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL - If
colorAttachmentCountis not 0 and theimageViewmember of an element ofpColorAttachmentsis notNULL_HANDLE, if theresolveModemember of that element ofpColorAttachmentsis notRESOLVE_MODE_NONE, itsresolveImageLayoutmember must not beIMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL,IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL,IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, orIMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL - If
pDepthAttachmentis notNULLandpDepthAttachment\u2192imageViewis notNULL_HANDLE,pDepthAttachment\u2192resolveModemust be one of the bits set inVkPhysicalDeviceDepthStencilResolveProperties::supportedDepthResolveModes - If
pStencilAttachmentis notNULLandpStencilAttachment\u2192imageViewis notNULL_HANDLE,pStencilAttachment\u2192resolveModemust be one of the bits set inVkPhysicalDeviceDepthStencilResolveProperties::supportedStencilResolveModes - If
pDepthAttachmentorpStencilAttachmentare both notNULL,pDepthAttachment\u2192imageViewandpStencilAttachment\u2192imageVieware both notNULL_HANDLE, andVkPhysicalDeviceDepthStencilResolveProperties::independentResolveNoneisFALSE, theresolveModeof both structures must be the same value - If
pDepthAttachmentorpStencilAttachmentare both notNULL,pDepthAttachment\u2192imageViewandpStencilAttachment\u2192imageVieware both notNULL_HANDLE,VkPhysicalDeviceDepthStencilResolveProperties::independentResolveisFALSE, and theresolveModeof neither structure isRESOLVE_MODE_NONE, theresolveModeof both structures must be the same value colorAttachmentCountmust be less than or equal toVkPhysicalDeviceLimits::maxColorAttachments- If the
imageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE, and non-subsample image feature is not enabled, validimageViewandresolveImageViewmembers ofpDepthAttachment,pStencilAttachment, and each element ofpColorAttachmentsmust be aVkImageViewcreated withIMAGE_CREATE_SUBSAMPLED_BIT_EXT - If the
imageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE, andviewMaskis not 0,imageViewmust have alayerCountgreater than or equal to the index of the most significant bit inviewMask - If the
imageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE, andviewMaskis 0,imageViewmust have alayerCountequal to 1 - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0 and theimageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a width greater than or equal toceil((renderAreax+renderAreawidth) / maxFragmentDensityTexelSizewidth) - If the
pNextchain contains aVkDeviceGroupRenderPassBeginInfostructure, itsdeviceRenderAreaCountmember is not 0, and theimageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a width greater than or equal toceil((pDeviceRenderAreasx+pDeviceRenderAreaswidth) / maxFragmentDensityTexelSizewidth)for each element ofpDeviceRenderAreas - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0 and theimageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a height greater than or equal toceil((renderAreay+renderAreaheight) / maxFragmentDensityTexelSizeheight) - If the
pNextchain contains aVkDeviceGroupRenderPassBeginInfostructure, itsdeviceRenderAreaCountmember is not 0, and theimageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a height greater than or equal toceil((pDeviceRenderAreasy+pDeviceRenderAreasheight) / maxFragmentDensityTexelSizeheight)for each element ofpDeviceRenderAreas - If the
imageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain is notNULL_HANDLE, it must not be equal to theimageVieworresolveImageViewmember ofpDepthAttachment,pStencilAttachment, or any element ofpColorAttachments - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0 and theimageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a width greater than or equal toceil((renderAreax+renderAreawidth) / shadingRateAttachmentTexelSizewidth) - If the
pNextchain contains aVkDeviceGroupRenderPassBeginInfostructure, itsdeviceRenderAreaCountmember is not 0, and theimageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a width greater than or equal toceil((pDeviceRenderAreasx+pDeviceRenderAreaswidth) / shadingRateAttachmentTexelSizewidth)for each element ofpDeviceRenderAreas - If the
pNextchain does not containVkDeviceGroupRenderPassBeginInfoor itsdeviceRenderAreaCountmember is equal to 0 and theimageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a height greater than or equal toceil((renderAreay+renderAreaheight) / shadingRateAttachmentTexelSizeheight) - If the
pNextchain contains aVkDeviceGroupRenderPassBeginInfostructure, itsdeviceRenderAreaCountmember is not 0, and theimageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE,imageViewmust have a height greater than or equal toceil((pDeviceRenderAreasy+pDeviceRenderAreasheight) / shadingRateAttachmentTexelSizeheight)for each element ofpDeviceRenderAreas - If the
imageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE, andviewMaskis 0,imageViewmust have alayerCountthat is either equal to 1 or greater than or equal tolayerCount - If the
imageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE, andviewMaskis not 0,imageViewmust have alayerCountthat either equal to 1 or greater than or equal to the index of the most significant bit inviewMask - If the
imageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE, it must not be equal to theimageVieworresolveImageViewmember ofpDepthAttachment,pStencilAttachment, or any element ofpColorAttachments - If the
imageViewmember of aVkRenderingFragmentShadingRateAttachmentInfoKHRstructure included in thepNextchain is notNULL_HANDLE, it must not be equal to theimageViewmember of aVkRenderingFragmentDensityMapAttachmentInfoEXTstructure included in thepNextchain - If the
multiviewfeature is not enabled,viewMaskmust be 0 - The index of the most significant bit in
viewMaskmust be less thanmaxMultiviewViewCount
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RENDERING_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkDeviceGroupRenderPassBeginInfo,VkMultiviewPerViewAttributesInfoNVX,VkRenderingFragmentDensityMapAttachmentInfoEXT, orVkRenderingFragmentShadingRateAttachmentInfoKHR - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be a valid combination ofVkRenderingFlagBitsvalues- If
colorAttachmentCountis not 0,pColorAttachmentsmust be a valid pointer to an array ofcolorAttachmentCountvalidVkRenderingAttachmentInfostructures - If
pDepthAttachmentis notNULL,pDepthAttachmentmust be a valid pointer to a validVkRenderingAttachmentInfostructure - If
pStencilAttachmentis notNULL,pStencilAttachmentmust be a valid pointer to a validVkRenderingAttachmentInfostructure
See Also
VkRect2D,VkRenderingAttachmentInfo,CmdBeginRendering,CmdBeginRenderingKHRLayout
struct VkRenderingInfo { VkStructureTypesType(); void const *pNext(); VkRenderingFlagsflags();VkRect2DrenderArea(); uint32_tlayerCount(); uint32_tviewMask(); uint32_tcolorAttachmentCount();VkRenderingAttachmentInfoconst *pColorAttachments();VkRenderingAttachmentInfoconst *pDepthAttachment();VkRenderingAttachmentInfoconst *pStencilAttachment(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkRenderingInfo.BufferAn array ofVkRenderingInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCOLORATTACHMENTCOUNT
FLAGS
LAYERCOUNT
PCOLORATTACHMENTS
PDEPTHATTACHMENT
PNEXT
PSTENCILATTACHMENT
RENDERAREAThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
VIEWMASKThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRenderingInfo(java.nio.ByteBuffer container)Creates aVkRenderingInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkRenderingInfocalloc()Returns a newVkRenderingInfoinstance allocated withmemCalloc.static VkRenderingInfo.Buffercalloc(int capacity)Returns a newVkRenderingInfo.Bufferinstance allocated withmemCalloc.static VkRenderingInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderingInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intcolorAttachmentCount()the number of elements inpColorAttachments.static VkRenderingInfocreate()Returns a newVkRenderingInfoinstance allocated withBufferUtils.static VkRenderingInfo.Buffercreate(int capacity)Returns a newVkRenderingInfo.Bufferinstance allocated withBufferUtils.static VkRenderingInfocreate(long address)Returns a newVkRenderingInfoinstance for the specified memory address.static VkRenderingInfo.Buffercreate(long address, int capacity)Create aVkRenderingInfo.Bufferinstance at the specified memory.static VkRenderingInfocreateSafe(long address)static VkRenderingInfo.BuffercreateSafe(long address, int capacity)intflags()a bitmask ofVkRenderingFlagBits.VkRenderingInfoflags(int value)Sets the specified value to theflags()field.intlayerCount()the number of layers rendered to in each attachment whenviewMaskis 0.VkRenderingInfolayerCount(int value)Sets the specified value to thelayerCount()field.static VkRenderingInfomalloc()Returns a newVkRenderingInfoinstance allocated withmemAlloc.static VkRenderingInfo.Buffermalloc(int capacity)Returns a newVkRenderingInfo.Bufferinstance allocated withmemAlloc.static VkRenderingInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkRenderingInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingInfoinstance allocated on the specifiedMemoryStack.static intncolorAttachmentCount(long struct)Unsafe version ofcolorAttachmentCount().static voidncolorAttachmentCount(long struct, int value)Sets the specified value to thecolorAttachmentCountfield of the specifiedstruct.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intnlayerCount(long struct)Unsafe version oflayerCount().static voidnlayerCount(long struct, int value)Unsafe version oflayerCount.static VkRenderingAttachmentInfo.BuffernpColorAttachments(long struct)Unsafe version ofpColorAttachments().static voidnpColorAttachments(long struct, VkRenderingAttachmentInfo.Buffer value)Unsafe version ofpColorAttachments.static VkRenderingAttachmentInfonpDepthAttachment(long struct)Unsafe version ofpDepthAttachment().static voidnpDepthAttachment(long struct, VkRenderingAttachmentInfo value)Unsafe version ofpDepthAttachment.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkRenderingAttachmentInfonpStencilAttachment(long struct)Unsafe version ofpStencilAttachment().static voidnpStencilAttachment(long struct, VkRenderingAttachmentInfo value)Unsafe version ofpStencilAttachment.static VkRect2DnrenderArea(long struct)Unsafe version ofrenderArea().static voidnrenderArea(long struct, VkRect2D value)Unsafe version ofrenderArea.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnviewMask(long struct)Unsafe version ofviewMask().static voidnviewMask(long struct, int value)Unsafe version ofviewMask.VkRenderingAttachmentInfo.BufferpColorAttachments()a pointer to an array ofcolorAttachmentCountVkRenderingAttachmentInfostructures describing any color attachments used.VkRenderingInfopColorAttachments(VkRenderingAttachmentInfo.Buffer value)Sets the address of the specifiedVkRenderingAttachmentInfo.Bufferto thepColorAttachments()field.VkRenderingAttachmentInfopDepthAttachment()a pointer to aVkRenderingAttachmentInfostructure describing a depth attachment.VkRenderingInfopDepthAttachment(VkRenderingAttachmentInfo value)Sets the address of the specifiedVkRenderingAttachmentInfoto thepDepthAttachment()field.longpNext()NULLor a pointer to a structure extending this structure.VkRenderingInfopNext(long value)Sets the specified value to thepNext()field.VkRenderingInfopNext(VkDeviceGroupRenderPassBeginInfo value)Prepends the specifiedVkDeviceGroupRenderPassBeginInfovalue to thepNextchain.VkRenderingInfopNext(VkDeviceGroupRenderPassBeginInfoKHR value)Prepends the specifiedVkDeviceGroupRenderPassBeginInfoKHRvalue to thepNextchain.VkRenderingInfopNext(VkMultiviewPerViewAttributesInfoNVX value)Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain.VkRenderingInfopNext(VkRenderingFragmentDensityMapAttachmentInfoEXT value)Prepends the specifiedVkRenderingFragmentDensityMapAttachmentInfoEXTvalue to thepNextchain.VkRenderingInfopNext(VkRenderingFragmentShadingRateAttachmentInfoKHR value)Prepends the specifiedVkRenderingFragmentShadingRateAttachmentInfoKHRvalue to thepNextchain.VkRenderingAttachmentInfopStencilAttachment()a pointer to aVkRenderingAttachmentInfostructure describing a stencil attachment.VkRenderingInfopStencilAttachment(VkRenderingAttachmentInfo value)Sets the address of the specifiedVkRenderingAttachmentInfoto thepStencilAttachment()field.VkRect2DrenderArea()the render area that is affected by the render pass instance.VkRenderingInforenderArea(java.util.function.Consumer<VkRect2D> consumer)Passes therenderArea()field to the specifiedConsumer.VkRenderingInforenderArea(VkRect2D value)Copies the specifiedVkRect2Dto therenderArea()field.VkRenderingInfoset(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, VkRenderingAttachmentInfo.Buffer pColorAttachments, VkRenderingAttachmentInfo pDepthAttachment, VkRenderingAttachmentInfo pStencilAttachment)Initializes this struct with the specified values.VkRenderingInfoset(VkRenderingInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkRenderingInfosType(int value)Sets the specified value to thesType()field.VkRenderingInfosType$Default()Sets theSTRUCTURE_TYPE_RENDERING_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.intviewMask()the view mask indicating the indices of attachment layers that will be rendered when it is not 0.VkRenderingInfoviewMask(int value)Sets the specified value to theviewMask()field.
-
-
-
Constructor Detail
-
VkRenderingInfo
public VkRenderingInfo(java.nio.ByteBuffer container)
Creates aVkRenderingInfoinstance 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()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
flags
public int flags()
a bitmask ofVkRenderingFlagBits.
-
renderArea
public VkRect2D renderArea()
the render area that is affected by the render pass instance.
-
layerCount
public int layerCount()
the number of layers rendered to in each attachment whenviewMaskis 0.
-
viewMask
public int viewMask()
the view mask indicating the indices of attachment layers that will be rendered when it is not 0.
-
colorAttachmentCount
public int colorAttachmentCount()
the number of elements inpColorAttachments.
-
pColorAttachments
@Nullable public VkRenderingAttachmentInfo.Buffer pColorAttachments()
a pointer to an array ofcolorAttachmentCountVkRenderingAttachmentInfostructures describing any color attachments used.
-
pDepthAttachment
@Nullable public VkRenderingAttachmentInfo pDepthAttachment()
a pointer to aVkRenderingAttachmentInfostructure describing a depth attachment.
-
pStencilAttachment
@Nullable public VkRenderingAttachmentInfo pStencilAttachment()
a pointer to aVkRenderingAttachmentInfostructure describing a stencil attachment.
-
sType
public VkRenderingInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkRenderingInfo sType$Default()
Sets theSTRUCTURE_TYPE_RENDERING_INFOvalue to thesType()field.
-
pNext
public VkRenderingInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkRenderingInfo pNext(VkDeviceGroupRenderPassBeginInfo value)
Prepends the specifiedVkDeviceGroupRenderPassBeginInfovalue to thepNextchain.
-
pNext
public VkRenderingInfo pNext(VkDeviceGroupRenderPassBeginInfoKHR value)
Prepends the specifiedVkDeviceGroupRenderPassBeginInfoKHRvalue to thepNextchain.
-
pNext
public VkRenderingInfo pNext(VkMultiviewPerViewAttributesInfoNVX value)
Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain.
-
pNext
public VkRenderingInfo pNext(VkRenderingFragmentDensityMapAttachmentInfoEXT value)
Prepends the specifiedVkRenderingFragmentDensityMapAttachmentInfoEXTvalue to thepNextchain.
-
pNext
public VkRenderingInfo pNext(VkRenderingFragmentShadingRateAttachmentInfoKHR value)
Prepends the specifiedVkRenderingFragmentShadingRateAttachmentInfoKHRvalue to thepNextchain.
-
flags
public VkRenderingInfo flags(int value)
Sets the specified value to theflags()field.
-
renderArea
public VkRenderingInfo renderArea(VkRect2D value)
Copies the specifiedVkRect2Dto therenderArea()field.
-
renderArea
public VkRenderingInfo renderArea(java.util.function.Consumer<VkRect2D> consumer)
Passes therenderArea()field to the specifiedConsumer.
-
layerCount
public VkRenderingInfo layerCount(int value)
Sets the specified value to thelayerCount()field.
-
viewMask
public VkRenderingInfo viewMask(int value)
Sets the specified value to theviewMask()field.
-
pColorAttachments
public VkRenderingInfo pColorAttachments(@Nullable VkRenderingAttachmentInfo.Buffer value)
Sets the address of the specifiedVkRenderingAttachmentInfo.Bufferto thepColorAttachments()field.
-
pDepthAttachment
public VkRenderingInfo pDepthAttachment(@Nullable VkRenderingAttachmentInfo value)
Sets the address of the specifiedVkRenderingAttachmentInfoto thepDepthAttachment()field.
-
pStencilAttachment
public VkRenderingInfo pStencilAttachment(@Nullable VkRenderingAttachmentInfo value)
Sets the address of the specifiedVkRenderingAttachmentInfoto thepStencilAttachment()field.
-
set
public VkRenderingInfo set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, @Nullable VkRenderingAttachmentInfo.Buffer pColorAttachments, @Nullable VkRenderingAttachmentInfo pDepthAttachment, @Nullable VkRenderingAttachmentInfo pStencilAttachment)
Initializes this struct with the specified values.
-
set
public VkRenderingInfo set(VkRenderingInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkRenderingInfo malloc()
Returns a newVkRenderingInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRenderingInfo calloc()
Returns a newVkRenderingInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRenderingInfo create()
Returns a newVkRenderingInfoinstance allocated withBufferUtils.
-
create
public static VkRenderingInfo create(long address)
Returns a newVkRenderingInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkRenderingInfo createSafe(long address)
-
malloc
public static VkRenderingInfo.Buffer malloc(int capacity)
Returns a newVkRenderingInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRenderingInfo.Buffer calloc(int capacity)
Returns a newVkRenderingInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderingInfo.Buffer create(int capacity)
Returns a newVkRenderingInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderingInfo.Buffer create(long address, int capacity)
Create aVkRenderingInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkRenderingInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static VkRenderingInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkRenderingInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkRenderingInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkRenderingInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
nrenderArea
public static VkRect2D nrenderArea(long struct)
Unsafe version ofrenderArea().
-
nlayerCount
public static int nlayerCount(long struct)
Unsafe version oflayerCount().
-
nviewMask
public static int nviewMask(long struct)
Unsafe version ofviewMask().
-
ncolorAttachmentCount
public static int ncolorAttachmentCount(long struct)
Unsafe version ofcolorAttachmentCount().
-
npColorAttachments
@Nullable public static VkRenderingAttachmentInfo.Buffer npColorAttachments(long struct)
Unsafe version ofpColorAttachments().
-
npDepthAttachment
@Nullable public static VkRenderingAttachmentInfo npDepthAttachment(long struct)
Unsafe version ofpDepthAttachment().
-
npStencilAttachment
@Nullable public static VkRenderingAttachmentInfo npStencilAttachment(long struct)
Unsafe version ofpStencilAttachment().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
nrenderArea
public static void nrenderArea(long struct, VkRect2D value)Unsafe version ofrenderArea.
-
nlayerCount
public static void nlayerCount(long struct, int value)Unsafe version oflayerCount.
-
nviewMask
public static void nviewMask(long struct, int value)Unsafe version ofviewMask.
-
ncolorAttachmentCount
public static void ncolorAttachmentCount(long struct, int value)Sets the specified value to thecolorAttachmentCountfield of the specifiedstruct.
-
npColorAttachments
public static void npColorAttachments(long struct, @Nullable VkRenderingAttachmentInfo.Buffer value)Unsafe version ofpColorAttachments.
-
npDepthAttachment
public static void npDepthAttachment(long struct, @Nullable VkRenderingAttachmentInfo value)Unsafe version ofpDepthAttachment.
-
npStencilAttachment
public static void npStencilAttachment(long struct, @Nullable VkRenderingAttachmentInfo value)Unsafe version ofpStencilAttachment.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-