public Class VkRenderingAttachmentInfo

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 NULL_HANDLE, other members of this structure are ignored; writes to this attachment will be discarded, and no load, store, or multisample resolve operations will be performed.

If resolveMode is RESOLVE_MODE_NONE, then resolveImageView is ignored. If resolveMode is not RESOLVE_MODE_NONE, and resolveImageView is not NULL_HANDLE, a render pass multisample resolve operation is defined for the attachment subresource.

Store and resolve operations are only performed at the end of a render pass instance that does not specify the RENDERING_SUSPENDING_BIT_KHR flag.

Load operations are only performed at the beginning of a render pass instance that does not specify the 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.

Valid Usage

• If imageView is not NULL_HANDLE and has a non-integer color format, resolveMode must be RESOLVE_MODE_NONE or RESOLVE_MODE_AVERAGE_BIT
• If imageView is not NULL_HANDLE and has an integer color format, resolveMode must be RESOLVE_MODE_NONE or RESOLVE_MODE_SAMPLE_ZERO_BIT
• If imageView is not NULL_HANDLE, resolveMode is not RESOLVE_MODE_NONE, and the pNext chain of VkRenderingInfo does not includes a VkMultisampledRenderToSingleSampledInfoEXT structure with the multisampledRenderToSingleSampledEnable field equal to TRUE, imageView must not have a sample count of SAMPLE_COUNT_1_BIT
• If imageView is not NULL_HANDLE, resolveMode is not RESOLVE_MODE_NONE, and the pNext chain of VkRenderingInfo does not includes a VkMultisampledRenderToSingleSampledInfoEXT structure with the multisampledRenderToSingleSampledEnable field equal to TRUE, resolveImageView must not be NULL_HANDLE
• If imageView is not NULL_HANDLE, resolveMode is not RESOLVE_MODE_NONE, the pNext chain of VkRenderingInfo includes a VkMultisampledRenderToSingleSampledInfoEXT structure with the multisampledRenderToSingleSampledEnable field equal to TRUE, and imageView has a sample count of SAMPLE_COUNT_1_BIT, resolveImageView must be NULL_HANDLE
• If imageView is not NULL_HANDLE, resolveImageView is not NULL_HANDLE, and resolveMode is not RESOLVE_MODE_NONE, resolveImageView must have a sample count of SAMPLE_COUNT_1_BIT
• If imageView is not NULL_HANDLE, resolveImageView is not NULL_HANDLE, and resolveMode is not RESOLVE_MODE_NONE, imageView and resolveImageView must have the same VkFormat
• If imageView is not NULL_HANDLE, imageLayout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, or IMAGE_LAYOUT_PREINITIALIZED
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, or IMAGE_LAYOUT_PREINITIALIZED
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If imageView is not NULL_HANDLE, imageLayout must not be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV
• If imageView is not NULL_HANDLE, imageLayout must not be IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
• If imageView is not NULL_HANDLE, imageLayout must not be IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
• If imageView is not NULL_HANDLE, imageLayout must not be IMAGE_LAYOUT_PRESENT_SRC_KHR
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_PRESENT_SRC_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_ATTACHMENT_INFO
• pNext must be NULL
• If imageView is not NULL_HANDLE, imageView must be a valid VkImageView handle
• imageLayout must be a valid VkImageLayout value
• If resolveMode is not 0, resolveMode must be a valid VkResolveModeFlagBits value
• If resolveImageView is not NULL_HANDLE, resolveImageView must be a valid VkImageView handle
• resolveImageLayout must be a valid VkImageLayout value
• loadOp must be a valid VkAttachmentLoadOp value
• storeOp must be a valid VkAttachmentStoreOp value
• clearValue must be a valid VkClearValue union
• Both of imageView, and resolveImageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

See Also

VkClearValue, VkRenderingInfo

Layout

struct VkRenderingAttachmentInfo {
    VkStructureType sType;
    void const * pNext;
    VkImageView imageView;
    VkImageLayout imageLayout;
    VkResolveModeFlagBits resolveMode;
    VkImageView resolveImageView;
    VkImageLayout resolveImageLayout;
    VkAttachmentLoadOp loadOp;
    VkAttachmentStoreOp storeOp;
    VkClearValue clearValue;
}