Vulkan-Docs/doc/specs/vulkan/man/VkSparseImageFormatProperti...

71 lines
2.4 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
VkSparseImageFormatProperties(3)
================================
Name
----
VkSparseImageFormatProperties - Structure specifying sparse image format properties
C Specification
---------------
// refBegin VkSparseImageFormatProperties - Structure specifying sparse image format properties
The sname:VkSparseImageFormatProperties structure is defined as:
include::../api/structs/VkSparseImageFormatProperties.txt[]
Members
-------
* pname:aspectMask is a bitmask of elink:VkImageAspectFlagBits specifying
which aspects of the image the properties apply to.
* pname:imageGranularity is the width, height, and depth of the
sparse image block in texels or compressed texel blocks.
* pname:flags is a bitmask specifying additional information about the
sparse resource. Bits which can: be set include:
+
--
// refBegin VkSparseImageFormatFlagBits - Bitmask specifying additional information about a sparse image resource
include::../api/enums/VkSparseImageFormatFlagBits.txt[]
--
** If ename:VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT is set, the image
uses a single mip tail region for all array layers.
** If ename:VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT is set, the first
mip level whose dimensions are not integer multiples of the corresponding
dimensions of the sparse image block begins the mip tail region.
** If ename:VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT is set, the
image uses non-standard sparse image block dimensions, and the
pname:imageGranularity values do not match the standard sparse image
block dimensions for the given pixel format.
Description
-----------
include::../validity/structs/VkSparseImageFormatProperties.txt[]
See Also
--------
slink:VkExtent3D, elink:VkImageAspectFlags, elink:VkSparseImageFormatFlags, slink:VkSparseImageMemoryRequirements, flink:vkGetPhysicalDeviceSparseImageFormatProperties
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkSparseImageFormatProperties
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]