mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-31 16:46:05 +00:00
e2d981c029
* Bump API patch number and header version number to 20 for this update. Github Issues: * Replaced existing reference pages by text automatically extracted from the specification source, or generated from vk.xml in some cases. This isn't a complete solution for the reference pages, but puts them in a much better state. The ref pages (only) are now placed under a CC BY open source license, which is more current than the obsolete license previously used. Further improvements to the pages should not edit them directly, but instead concentrate on the specification source from which the ref pages are being extracted (public issues 44, 55, 160; internal issue 389).
94 lines
4.0 KiB
Plaintext
94 lines
4.0 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/
|
|
|
|
VkPhysicalDeviceSparseProperties(3)
|
|
===================================
|
|
|
|
Name
|
|
----
|
|
VkPhysicalDeviceSparseProperties - Structure specifying physical device sparse memory properties
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin VkPhysicalDeviceSparseProperties - Structure specifying physical device sparse memory properties
|
|
|
|
The sname:VkPhysicalDeviceSparseProperties structure is defined as:
|
|
|
|
include::../structs/VkPhysicalDeviceSparseProperties.txt[]
|
|
|
|
|
|
Members
|
|
-------
|
|
|
|
* pname:residencyStandard2DBlockShape is ename:VK_TRUE if the physical
|
|
device will access all single-sample 2D sparse resources using the
|
|
standard sparse image block shapes (based on image format), as described
|
|
in the <<sparsememory-sparseblockshapessingle,Standard Sparse Image Block
|
|
Shapes (Single Sample)>> table. If this property is not supported the
|
|
value returned in the pname:imageGranularity member of the
|
|
sname:VkSparseImageFormatProperties structure for single-sample 2D
|
|
images is not required: to match the standard sparse image block
|
|
dimensions listed in the table.
|
|
* pname:residencyStandard2DMultisampleBlockShape is ename:VK_TRUE if the
|
|
physical device will access all multisample 2D sparse resources using
|
|
the standard sparse image block shapes (based on image format), as
|
|
described in the <<sparsememory-sparseblockshapesmsaa,Standard Sparse
|
|
Image Block Shapes (MSAA)>> table. If this property is not supported, the
|
|
value returned in the pname:imageGranularity member of the
|
|
sname:VkSparseImageFormatProperties structure for multisample 2D images
|
|
is not required: to match the standard sparse image block dimensions
|
|
listed in the table.
|
|
* pname:residencyStandard3DBlockShape is ename:VK_TRUE if the physical
|
|
device will access all 3D sparse resources using the standard sparse image
|
|
block shapes (based on image format), as described in the
|
|
<<sparsememory-sparseblockshapessingle,Standard Sparse Image Block
|
|
Shapes (Single Sample)>> table. If this property is not supported, the
|
|
value returned in the pname:imageGranularity member of the
|
|
sname:VkSparseImageFormatProperties structure for 3D images is not
|
|
required: to match the standard sparse image block dimensions listed in
|
|
the table.
|
|
* pname:residencyAlignedMipSize is ename:VK_TRUE if images with mip level
|
|
dimensions that are not integer multiples of the corresponding dimensions
|
|
of the sparse image block may: be placed in the mip tail. If this property
|
|
is not reported, only mip levels with dimensions smaller than the
|
|
pname:imageGranularity member of the sname:VkSparseImageFormatProperties
|
|
structure will be placed in the mip tail. If this property is reported the
|
|
implementation is allowed to return
|
|
ename:VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT in the pname:flags
|
|
member of sname:VkSparseImageFormatProperties, indicating that mip level
|
|
dimensions that are not integer multiples of the corresponding dimensions
|
|
of the sparse image block will be placed in the mip tail.
|
|
* pname:residencyNonResidentStrict specifies whether the physical device
|
|
can: consistently access non-resident regions of a resource. If this
|
|
property is ename:VK_TRUE, access to non-resident regions of resources
|
|
will be guaranteed to return values as if the resource were populated
|
|
with 0; writes to non-resident regions will be discarded.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
include::../validity/structs/VkPhysicalDeviceSparseProperties.txt[]
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
basetypes:VkBool32, slink:VkPhysicalDeviceProperties
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkPhysicalDeviceSparseProperties
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|