VkImageFormatListCreateInfo(3)

# VkImageFormatListCreateInfo(3) Manual Page

## Name

VkImageFormatListCreateInfo - Specify that an image can: be used with a particular set of formats

Loading… please wait.

## C Specification

If the `pNext` chain of VkImageCreateInfo includes a `VkImageFormatListCreateInfo` structure, then that structure contains a list of all formats that can be used when creating views of this image.

The `VkImageFormatListCreateInfo` structure is defined as:

    // Provided by VK_VERSION_1_2
    typedef struct VkImageFormatListCreateInfo {
        VkStructureType    sType;
        const void*        pNext;
        uint32_t           viewFormatCount;
        const VkFormat*    pViewFormats;
    } VkImageFormatListCreateInfo;

or the equivalent

    // Provided by VK_KHR_image_format_list
    typedef VkImageFormatListCreateInfo VkImageFormatListCreateInfoKHR;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `viewFormatCount` is the number of entries in the `pViewFormats` array.

- `pViewFormats` is a pointer to an array of VkFormat values specifying all formats which can be used when creating views of this image.

## Description

If `viewFormatCount` is zero, `pViewFormats` is ignored and the image is created as if the `VkImageFormatListCreateInfo` structure were not included in the `pNext` chain of VkImageCreateInfo.

Valid Usage (Implicit)

- VUID-VkImageFormatListCreateInfo-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO`

- VUID-VkImageFormatListCreateInfo-pViewFormats-parameter
  If `viewFormatCount` is not `0`, `pViewFormats` must be a valid pointer to an array of `viewFormatCount` valid VkFormat values

## See Also

VK_KHR_image_format_list, VK_VERSION_1_2, VkFormat, VkStructureType

## 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

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0