C Specification
The VkImageFormatProperties
structure is defined as:
// Provided by VK_VERSION_1_0
typedef struct VkImageFormatProperties {
VkExtent3D maxExtent;
uint32_t maxMipLevels;
uint32_t maxArrayLayers;
VkSampleCountFlags sampleCounts;
VkDeviceSize maxResourceSize;
} VkImageFormatProperties;
Members
-
maxExtent
are the maximum image dimensions. See the Allowed Extent Values section below for how these values are constrained bytype
. -
maxMipLevels
is the maximum number of mipmap levels.maxMipLevels
must be equal to the number of levels in the complete mipmap chain based on themaxExtent.width
,maxExtent.height
, andmaxExtent.depth
, except when one of the following conditions is true, in which case it may instead be1
:-
vkGetPhysicalDeviceImageFormatProperties
::tiling
wasVK_IMAGE_TILING_LINEAR
-
VkPhysicalDeviceImageFormatInfo2::
tiling
wasVK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
-
the VkPhysicalDeviceImageFormatInfo2::
pNext
chain included a VkPhysicalDeviceExternalImageFormatInfo structure with a handle type included in thehandleTypes
member for which mipmap image support is not required -
image
format
is one of the formats that require a sampler Y′CBCR conversion
-
-
maxArrayLayers
is the maximum number of array layers.maxArrayLayers
must be no less than VkPhysicalDeviceLimits::maxImageArrayLayers
, except when one of the following conditions is true, in which case it may instead be1
:-
tiling
isVK_IMAGE_TILING_LINEAR
-
tiling
isVK_IMAGE_TILING_OPTIMAL
andtype
isVK_IMAGE_TYPE_3D
-
format
is one of the formats that require a sampler Y′CBCR conversion
-
-
If
tiling
isVK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
, thenmaxArrayLayers
must not be 0. -
sampleCounts
is a bitmask of VkSampleCountFlagBits specifying all the supported sample counts for this image as described below. -
maxResourceSize
is an upper bound on the total image size in bytes, inclusive of all image subresources. Implementations may have an address space limit on total size of a resource, which is advertised by this property.maxResourceSize
must be at least 231.
Description
Note
There is no mechanism to query the size of an image before creating it, to
compare that size against |
If the combination of parameters to
vkGetPhysicalDeviceImageFormatProperties
is not supported by the
implementation for use in vkCreateImage, then all members of
VkImageFormatProperties
will be filled with zero.
Note
Filling |
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.