C Specification
The VkRenderingAttachmentInfo
structure is defined as:
// Provided by VK_VERSION_1_3
typedef struct VkRenderingAttachmentInfo {
VkStructureType sType;
const void* pNext;
VkImageView imageView;
VkImageLayout imageLayout;
VkResolveModeFlagBits resolveMode;
VkImageView resolveImageView;
VkImageLayout resolveImageLayout;
VkAttachmentLoadOp loadOp;
VkAttachmentStoreOp storeOp;
VkClearValue clearValue;
} VkRenderingAttachmentInfo;
or the equivalent
// Provided by VK_KHR_dynamic_rendering
typedef VkRenderingAttachmentInfo VkRenderingAttachmentInfoKHR;
Members
-
sType
is the type of this structure. -
pNext
isNULL
or a pointer to a structure extending this structure. -
imageView
is the image view that will be used for rendering. -
imageLayout
is the layout thatimageView
will be in during rendering. -
resolveMode
is a VkResolveModeFlagBits value defining how multisampled data written toimageView
will be resolved. -
resolveImageView
is an image view used to write resolved multisample data at the end of rendering. -
resolveImageLayout
is the layout thatresolveImageView
will be in during rendering. -
loadOp
is a VkAttachmentLoadOp value specifying how the contents ofimageView
are treated at the start of the render pass instance. -
storeOp
is a VkAttachmentStoreOp value specifying how the contents ofimageView
are treated at the end of the render pass instance. -
clearValue
is a VkClearValue structure defining values used to clearimageView
whenloadOp
isVK_ATTACHMENT_LOAD_OP_CLEAR
.
Description
Values in imageView
are loaded and stored according to the values of
loadOp
and storeOp
, within the render area
for each device
specified in VkRenderingInfo.
If imageView
is VK_NULL_HANDLE, other members of this structure
are ignored; writes to this attachment will be discarded, and no load,
store, or resolve operations will be performed.
If resolveMode
is VK_RESOLVE_MODE_NONE
, then
resolveImageView
is ignored.
If resolveMode
is not VK_RESOLVE_MODE_NONE
, and
resolveImageView
is not VK_NULL_HANDLE, values in
resolveImageView
within the render area become undefined once
rendering begins.
Only values in the aspect corresponding to the use of this attachment become
undefined (the depth aspect if this attachment is used as
VkRenderingInfo::pDepthAttachment
, and the stencil aspect if it
is used as pStencilAttachment
).
At the end of rendering, the values written to each pixel location in
imageView
will be resolved according to resolveMode
and stored
into the same location in resolveImageView
.
Note
The resolve mode and store operation are independent; it is valid to write both resolved and unresolved values, and equally valid to discard the unresolved values while writing the resolved ones. |
Store and resolve operations are only performed at the end of a render pass
instance that does not specify the VK_RENDERING_SUSPENDING_BIT_KHR
flag.
Load operations are only performed at the beginning of a render pass
instance that does not specify the VK_RENDERING_RESUMING_BIT_KHR
flag.
Image contents at the end of a suspended render pass instance remain defined for access by a resuming render pass instance.
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.