Vulkan-Docs/doc/specs/vulkan/man/VkPhysicalDeviceSparseProperties.txt
Jon Leech 1ca0ea1ef0 Change log for July 22, 2016 Vulkan 1.0.22 spec update:
* Bump API patch number and header version number to 22 for this update.

Github Issues:

  * Translate the subpass self-dependency language into concrete
    validity statements, and added a validity statement about the
    restrictions on layout parameters (public issue 267).
  * Add validity requirement that
    slink:VkAttachmentDescription::pname:finalLayout and
    slink:VkAttachmentReference::pname:layout must not be
    ename:VK_IMAGE_LAYOUT_UNDEFINED or
    ename:VK_IMAGE_LAYOUT_PREINITIALIZED (public issue 268).
  * Clarify that slink:VkSubpassDescription::pname:pResolveAttachments
    layouts are used. Make language consistent with other attachment
    arrays (public issue 270).
  * Changed 64-bit definition for
    dname:VK_DEFINE_NON_DISPATCHABLE_HANDLE to work for x32 platform in
    +vk.xml+ and the resulting +vulkan.h+ (public issue 282).
  * Add missing error return code for
    flink:vkEnumerateInstanceExtensionProperties and
    flink:vkEnumerateDeviceExtensionProperties (public issue 285)
  * Fix several cases of stext::VkStructName.memberName markup to
    stext::VkStructName::pname:memberName, to match other usage in the
    spec, and describe this markup in the style guide (public issue
    286).
  * Modified validity language generation script to avoid redundant
    common ancestor language if covered by generic parent language, and
    used `Both' instead of `Each' when appropriate (public issue 288).

Internal Issues:

  * Add language about behavior of flink:vkAllocateDescriptorSets when
    allocation fails due to fragmentation, a new error
    ename:VK_ERROR_FRAGMENTED_POOL, and a Note explaining the situation
    (internal issue 309).
  * For the features of code:PointSize, code:ClipDistance, and
    code:CullDistance, the SPIR-V capability is required to be declared
    on use (read or write) rather than on decoration (internal issue
    359).
  * Have desktop versions of GLSL respect precision qualification
    (code:mediump and code:lowp) when compiling for Vulkan. These will
    get translated to SPIR-V's code:RelaxedPrecision decoration as they
    do with OpenGL ES versions of GLSL (ESSL). The default precision of
    all types is code:highp when using a desktop version (internal issue
    360).
  * Add validity statement for slink:VkImageCreateInfo specifying that
    multisampled images must be two-dimensional, optimally tiled, and
    with a single mipmap level (internal issue 369).
  * Add validity statements to slink:VkImageViewCreateInfo disallowing
    creation of images or image views with no supported features. Made
    some slink:VkImageViewCreateInfo validity statements more precise
    and consistent. Added a Note to the <<features,features>> chapter
    about formats with no features (internal issue 371).
  * Remove +manpages+ from default build targets. Nroff outputs
    containing imbedded latexmath will not render properly. Fixing this
    is a lot of work for limited use cases (internal issue 401).

Other Commits:

  * Fix flink:vkRenderPassBeginInfo::pname:clearValueCount validity
    statement to be based on attachment indices rather than the number
    of cleared attachments
    (Vulkan-LoaderAndValidationLayers/issues/601).
  * Convert registry documentation from LaTeX to asciidoc source and
    rename from +src/spec/readme.tex+ to +src/spec/registry.txt+.
  * Fix lack of Oxford commas in validity language.
  * Lots of cleanup of generator scripts and Makefiles to move extension
    list for generator into the script arguments instead of the body of
    genvk.py, and express better dependencies between XML, scripts, and
    generated files.
2016-07-23 03:15:48 -07:00

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::../api/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
--------
basetype: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[]