vkGetPhysicalDeviceSparseImageFormatProperties returns an array of
Each element will describe properties for one set of image aspects that are
bound simultaneously in the image.
This is usually one element for each aspect in the image, but for
interleaved depth/stencil images there is only one element describing the
void vkGetPhysicalDeviceSparseImageFormatProperties( VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type, VkSampleCountFlagBits samples, VkImageUsageFlags usage, VkImageTiling tiling, uint32_t* pPropertyCount, VkSparseImageFormatProperties* pProperties);
physicalDeviceis the physical device from which to query the sparse image capabilities.
formatis the image format.
typeis the dimensionality of image.
samplesis the number of samples per texel as defined in VkSampleCountFlagBits.
usageis a bitmask describing the intended usage of the image.
tilingis the tiling arrangement of the texel blocks in memory.
pPropertyCountis a pointer to an integer related to the number of sparse format properties available or queried, as described below.
NULLor a pointer to an array of VkSparseImageFormatProperties structures.
NULL, then the number of sparse format properties
available is returned in
pPropertyCount must point to a variable set by the user to
the number of elements in the
pProperties array, and on return the
variable is overwritten with the number of structures actually written to
pPropertyCount is less than the number of sparse format properties
available, at most
pPropertyCount structures will be written.
VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT is not supported for the given
pPropertyCount will be set to zero upon return, and no data
will be written to
Multiple aspects are returned for depth/stencil images that are implemented
as separate planes by the implementation.
The depth and stencil data planes each have unique
Depth/stencil images with depth and stencil data interleaved into a single
plane will return a single
aspectMask set to
For more information, see the Vulkan Specification at URL
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.