VKGETPHYSICALDEVICEI(3)

NAME
vkGetPhysicalDeviceImageFormatProperties - Lists physical device's image format capabilities.

C SPECIFICATION

To query additional capabilities specific to image types, call:

    VkResult vkGetPhysicalDeviceImageFormatProperties(
        VkPhysicalDevice                            physicalDevice,
        VkFormat                                    format,
        VkImageType                                 type,
        VkImageTiling                               tiling,
        VkImageUsageFlags                           usage,
        VkImageCreateFlags                          flags,
        VkImageFormatProperties*                    pImageFormatProperties);

PARAMETERS

    • physicalDevice is the physical device from which to query the image capabilities.

    • format is the image format, corresponding to VkImageCreateInfo::format.

    • type is the image type, corresponding to VkImageCreateInfo::imageType.

    • tiling is the image tiling, corresponding to VkImageCreateInfo::tiling.

    • usage is the intended usage of the image, corresponding to VkImageCreateInfo::usage.

    • flags is a bitmask describing additional parameters of the image, corresponding to VkImageCreateInfo::flags.

    • pImageFormatProperties points to an instance of the VkImageFormatProperties structure in which capabilities are returned.

DESCRIPTION

The format, type, tiling, usage, and flags parameters correspond to parameters that would be consumed by vkCreateImage.

If format is not a supported image format, or if the combination of format, type, tiling, usage, and flags is not supported for images, then vkGetPhysicalDeviceImageFormatProperties returns VK_ERROR_FORMAT_NOT_SUPPORTED.

The limitations on an image format that are reported by vkGetPhysicalDeviceImageFormatProperties have the following property: if usage1 and usage2 of type VkImageUsageFlags are such that the bits set in usage1 are a subset of the bits set in usage2, and flags1 and flags2 of type VkImageCreateFlags are such that the bits set in flags1 are a subset of the bits set in flags2, then the limitations for usage1 and flags1 must be no more strict than the limitations for usage2 and flags2, for all values of format, type, and tiling.

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • format must be a valid VkFormat value

    • type must be a valid VkImageType value

    • tiling must be a valid VkImageTiling value

    • usage must be a valid combination of VkImageUsageFlagBits values

    • usage must not be 0

    • flags must be a valid combination of VkImageCreateFlagBits values

    • pImageFormatProperties must be a pointer to a VkImageFormatProperties structure

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

        • VK_ERROR_FORMAT_NOT_SUPPORTED

SEE ALSO

VkFormat, VkImageCreateFlags, VkImageFormatProperties, VkImageTiling, VkImageType, VkImageUsageFlags, VkPhysicalDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkGetPhysicalDeviceImageFormatProperties

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

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

AUTHOR

Khronos Group
    Author.