C Specification

The VkFramebufferAttachmentImageInfoKHR structure is defined as:

typedef struct VkFramebufferAttachmentImageInfoKHR {
    VkStructureType       sType;
    const void*           pNext;
    VkImageCreateFlags    flags;
    VkImageUsageFlags     usage;
    uint32_t              width;
    uint32_t              height;
    uint32_t              layerCount;
    uint32_t              viewFormatCount;
    const VkFormat*       pViewFormats;
} VkFramebufferAttachmentImageInfoKHR;

Members

  • sType is the type of this structure.

  • pNext is NULL or a pointer to an extension-specific structure.

  • flags is a bitmask of VkImageCreateFlagBits, matching the value of VkImageCreateInfo::flags used to create an image that will be used with this framebuffer.

  • usage is a bitmask of VkImageUsageFlagBits, matching the value of VkImageCreateInfo::usage used to create an image used with this framebuffer.

  • width is the width of the image view used for rendering.

  • height is the height of the image view used for rendering.

  • viewFormatCount is the number of entries in the pViewFormats array, matching the value of VkImageFormatListCreateInfoKHR::viewFormatCount used to create an image used with this framebuffer.

  • pViewFormats is an array which lists of all formats which can be used when creating views of the image, matching the value of VkImageFormatListCreateInfoKHR::pViewFormats used to create an image used with this framebuffer.

Description

Images that can be used with the framebuffer when beginning a render pass, as specified by VkRenderPassAttachmentBeginInfoKHR, must be created with parameters that are identical to those specified here.

Valid Usage (Implicit)
  • sType must be VK_STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO_KHR

  • pNext must be NULL

  • flags must be a valid combination of VkImageCreateFlagBits values

  • usage must be a valid combination of VkImageUsageFlagBits values

  • usage must not be 0

  • If viewFormatCount is not 0, pViewFormats must be a valid pointer to an array of viewFormatCount valid VkFormat values

See Also

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.

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.