vkGetPhysicalDeviceFormatProperties(3)

Name

vkGetPhysicalDeviceFormatProperties - Lists physical device’s format capabilities

C Specification

To query supported format features which are properties of the physical device, call:

This functionality is superseded by Vulkan Version 1.1. See Legacy Functionality for more information.

// Provided by VK_VERSION_1_0
void vkGetPhysicalDeviceFormatProperties(
    VkPhysicalDevice                            physicalDevice,
    VkFormat                                    format,
    VkFormatProperties*                         pFormatProperties);

Parameters

physicalDevice is the physical device from which to query the format properties.
format is the format whose properties are queried.
pFormatProperties is a pointer to a VkFormatProperties structure in which physical device properties for format are returned.

Description

Valid Usage

VUID-vkGetPhysicalDeviceFormatProperties-None-12272
If Vulkan 1.3 is not supported, the maintenance5 feature is not supported, and the ycbcr2plane444Formats feature is not supported, format must not be VK_FORMAT_G8_B8R8_2PLANE_444_UNORM, VK_FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16, VK_FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16, or VK_FORMAT_G16_B16R16_2PLANE_444_UNORM

Valid Usage (Implicit)

VUID-vkGetPhysicalDeviceFormatProperties-physicalDevice-parameter
physicalDevice must be a valid VkPhysicalDevice handle
VUID-vkGetPhysicalDeviceFormatProperties-format-parameter
format must be a valid VkFormat value
VUID-vkGetPhysicalDeviceFormatProperties-pFormatProperties-parameter
pFormatProperties must be a valid pointer to a VkFormatProperties structure

See Also

VK_VERSION_1_0, VkFormat, VkFormatProperties, VkPhysicalDevice

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.