* Update release number to 98.
Public Issues:
* Fix missing markup in flink:vkDestroyPipelineLayout valid usage
statement (pull request 882).
* Add missing contributors for `<<VK_EXT_buffer_device_address>>` (public
pull request 891).
Internal Issues:
* Detect nested bullet points in valid usage blocks and warn about them
during VUID assignment (internal issue 1382).
* Update the style guide to document the process for reserving new bits in
bitmask types (internal issue 1411).
* Clarify for slink:VkApplicationInfo::pname:apiVersion and in the
<<fundamentals-validusage-versions, Valid Usage for Newer Core
Versions>> section when it is valid for an application to use a certain
version of Vulkan API functionality (for an instance and for a
device/physical device); and when the validation layers must generate an
error (internal issue 1412).
* Add optional <<memory-model-availability-visibility, transitive
availability/visibility operations to the memory model, including a new
pname:vulkanMemoryModelAvailabilityVisibilityChains feature for
slink:VkPhysicalDeviceVulkanMemoryModelFeaturesKHR (internal issue
1460).
* Add the code:StorageBuffer storage class to those in the
<<interfaces-resources-descset, Descriptor Set Interface>> (internal
issue 1480).
* Add missing `returnedonly` tags for a number of returned extension
structures that can be passed in pname:pNext chains (internal issue
1515).
* Clean up and rearrange some spec language for
slink:VkRenderPassCreateInfo and slink:VkAttachmentReference.txt
(internal issue 1522).
* Correctly round the code:OpVectorTimesScalar and
code:OpMatrixTimesScalar SPIR-V operations in the <<Precision of core
SPIR-V Instructions>> table (internal merge request 2996).
* Work around cases in flink:vkCmdBeginTransformFeedbackEXT,
flink:vkCmdEndTransformFeedbackEXT, and
slink:VkPipelineCoverageModulationStateCreateInfoNV where an array
parameter is `optional` but the length is not in `vk.xml`. This is an
interim fix using `noautovalidity` + handcoded VU replacing those that
should be autogenerated (internal issue 2944 and
https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/480).
* Remove redundant capability validation of the code:float16 and code:int8
SPIR-V capabilities from the <<spirvenv-capabilities, Capabilities>>
section, since they are already covered in the preceding table.
* Update check_spec_links script, including validation for reference page
open blocks. Fix errors identified by the script.
* Update release number to 97.
Public Issues:
* Add a special case to the <<renderpass-compatibility, Render Pass
Compatibility>> rules allowing single-subpass renderpasses to be
compatible even if they have different resolve attachment references
(public issue 835).
* Fix the miss shader binding table record address rule in the
<<shader-binding-table-indexing-rules, Miss Shaders>> section to index
by code:missIndex, not code:sbtOffset (public issue 875).
Internal Issues:
* Add a missing anchor to the elink:VkSamplerCreateFlagBits language
(internal issue 1483).
* Add missing implicit valid usage include for slink:VkHdrMetadataEXT and
corresponding `noautovalidity` attributes in `vk.xml` for the
externally-defined metadata properties (internal issue 1514).
* Remove restrictions on the `mask` parameter of SPIR-V's
code:OpGroupNonUniformXor in the <<spirvenv-module-validation,
Validation Rules within a Module>> appendix (internal merge request
2971).
* Restore `noautovalidity` attribute for
slink:VkPipelineViewportWScalingStateCreateInfoNV::pname:pViewportWScalings
in `vk.xml` (internal merge request 2975).
* Update copyright dates on Khronos-copyrighted files to 2019 (internal
merge request 2980).
New Extensions:
* `VK_KHR_depth_stencil_resolve`
* `VK_EXT_buffer_device_address`
* `VK_EXT_memory_budget`
* `VK_EXT_memory_priority`
* `VK_EXT_validation_features`
since 1.1.89; fixed now).
Change log for October 28, 2018 Vulkan 1.1.90 spec update:
* Update release number to 90.
Public Issues:
* Tag flink:vkQueueWaitIdle as `externsync` in `vk.xml` (public pull
request 815).
* Update README (public pull request 834).
* `VK_NV_framebuffer_mixed_samples` and `VK_AMD_mixed_attachment_samples`
had confusing and contradictory valid usage statements when read in the
all-extensions spec build. Change them to explicitly mention which
extension each is for (public issue Vulkan-ValidationLayers/issues/353).
Internal Issues:
* Update `COPYING.md` to clarify how externally generated Vulkan
Specifications (for translations, annotations, or other reasons) must be
copyrighted, and acknowledge the Exception Clause on the `vk.xml`
license (internal issue 1079).
* Specify that flink:vkGetPhysicalDeviceImageFormatProperties may: return
pname:maxMipLevels 1 if the format is ycbcr (internal issue 1361).
* Clarify previously underspecified language for
flink:vkCmdPushConstants::pname:pStageFlags regarding use of push
constants across multiple pipelines (internal issue 1403).
* Fix typo in XML/headers for
ename:VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT,
which was previously
etext:VK_STRUCTURE_TYPE_IMAGE_EXCPLICIT_DRM_FORMAT_MODIFIER_CREATE_INFO_EXT
(internal issue 1428).
* Fix markup of equations that were sporadically breaking the
`optimize-pdf` step of PDF generation, due (apparently) to inconsistent
treatment of unwrapped multicharacter terms by different LaTeX parsers
(internal issue 1435).
* For the <<memory-model-synchronizes-with synchronizes-with>> memory
model relation cases involving a release barrier plus relaxed atomic
write, treat the atomic as if it were a release atomic and allow the
acquire side to read from its hypothetical release sequence. This is
more consistent with how C++ defines synchronization for release fences
(internal issue cross-api/memory-model#72).
* Minor editorial changes to the <<memory-model, memory model>> appendix
based on external feedback.
* Update release number to 89.
Public Issues:
* Clarify the reference to <<features-limits-mipmapPrecisionBits, mipmap
precision bits>> in the <<textures-image-level-selection, Image Level(s)
Selection>> section (public issue 660).
* Update <<debugging-object-types,VkObjectType and Vulkan Handle
Relationship>> table with missing types (public pull request 820).
* Miscellaneous minor markup cleanup (public pull request 822).
* Fix copy/paste bugs in the description of how implicit
availability/visibility operations for atomics/barriers are ordered in
the <<memory-model-availability-visibility-semantics, Availability and
Visibility Semantics>> section (public issue 823).
* Add missing shading_rate_image bit from mesh pipeline list in the
<<synchronization-pipeline-stages-types>> list (public issue 824).
Internal Issues:
* Clarify that only statically used members of a push constant block need
to be in the push constant range, and stop referring to block members as
"`variables`" in the <<interfaces-resources-pushconst, Push Constant
Interface>> section. This is related to
https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/340
(internal issue 1401).
* Clarify interaction between flink:vkCmdSetDeviceMask and render pass
control commands in the slink:VkDeviceGroupRenderPassBeginInfo section
(internal issue 1416).
* Miscellaneous minor markup cleanup.
* Remove types defined by `"disabled"` extensions from
validextensionstructs in the XML processing scripts, so downstream code
generators don't emit them.
* Update release number to 88.
Public Issues:
* Make clear that
tname:PFN_vkDebugUtilsMessengerCallbackEXT::pname:messageTypes is a
bitmask, and correct a typo in the spelling of
slink:VkDebugUtilsMessengerCreateInfoEXT.txt::pname:messageType (public
pull request 800).
* Make an ABI-compatible change of the type of
slink:VkPhysicalDeviceDriverPropertiesKHR::pname:driverID to use the new
elink:VkDriverIdKHR type (public issue 811).
Internal Issues:
* Clarify for the <<features-features-shaderStorageImageExtendedFormats>>
feature and in the <<spirvenv-capabilities-table>> that the feature
means that all of the formats are supported, and that otherwise the
features can be queried per-format (internal issue 1273).
* Clarified interactions of `VK_EXT_external_memory_host` with host cache
management commands and structures flink:vkMapMemory,
flink:vkFlushMappedMemoryRanges, slink:VkMappedMemoryRange, and
flink:vkUnmapMemory using the new glossary term "`Host Mapped Device
Memory`" (internal issue 1385).
* Update the language for flink:vkCreateViSurfaceNN.txt describing the
pname:currentExtent of a VI surface to more accurately reflect current
capabilities, replacing "`undefined`" with more explicit behavior
(internal issue 1410).
New Extensions:
* `VK_EXT_calibrated_timestamps`
* `VK_EXT_image_drm_format_modifier` (this extension was previously
disabled in vk.xml, and has now been enabled after some changes to fix
performance issues).
* `VK_EXT_pci_bus_info`
* `VK_EXT_transform_feedback`
* `VK_GOOGLE_hlsl_functionality1`, exposing support for
`SPV_GOOGLE_hlsl_functionality1`.
* `VK_GOOGLE_decorate_string`, exposing support for
`SPV_GOOGLE_decorate_string`.
* Update release number to 87.
Public Issues:
* Merge flink:vkCmdPipelineBarrier self-dependency barrier VUs referring
to the same subpass dependency (public pull request 756).
* Describe default value of `"optional"` attribute in the registry schema
document (public issue 769)
* Fix links in <<VK_NVX_raytracing>> extension (public pull request 805).
* Mark the <<VK_KHR_mir_surface>> extension obsolete (see public issue 814
- does not close this, however).
* Fix missing endif in Image Creation block (public issue 817).
Internal Issues:
* Clarify that the compressed texture formats corresponding to
<<features-features-textureCompressionETC2>>,
<<features-features-textureCompressionASTC_LDR>>, and
<<features-features-textureCompressionBC>> is not contingent on the
feature bits, and may be supported even if the features are not enabled
(internal issue 663).
* Clarify that code:FragStencilRefEXT is output only in the
<<interfaces-builtin-variables, Built-In Variables>> section (internal
issue 1173).
* Identify and correct many overly-aggressive uses of "`undefined`", and
narrow them down, where straightforward to do so. Mark such resolved
uses of "`undefined`" with the custom undefined: macro. Add a new
<<writing-undefined, Describing Undefined Behavior>> section (internal
issue 1267).
* Don't require code:inline_uniform_block descriptors to be populated
before use in the flink:vkAllocateDescriptorSets section (internal issue
1380).
* Allow suppressing inline SVG images by controlling this with an
attribute set in the Makefile, rather than the explicit [%inline]
directive (internal issue 1391).
* Mark 'Khronos' as a registered trademark in several places, now that it
is one.
* Fix typo in the <<VK_KHR_shader_atomic_int64>> appendix using the GLSL
naming of the compare exchange op when referring to the SPIR-V op.
* Specify in the flink:vkGetPhysicalDeviceQueueFamilyProperties section
that all implementations must support at least one queue family, and
that every queue family must contain at least one queue.
* Make slink:VkPipelineDynamicStateCreateInfo::pname:dynamicStateCount,
slink:VkSampleLocationsInfoEXT::pname:sampleLocationsPerPixel, and
slink:VkSampleLocationsInfoEXT::pname:sampleLocationsCount optional, to
fix bogus implicit valid usage checks that were causing failures in the
conformance tests.
* Fix vendor tag in reserved extension 237 constants. Does not affect
anything since it's just a placeholder, but this should avoid further
comments.
* Minor markup fixes in some extension appendices.
New Extensions:
* `<<VK_FUCHSIA_imagepipe_surface>>`
* Update release number to 86.
Internal Issues:
* Add new <<resources-image-creation-limits, Image Creation Limits>>
section and reference that from valid usage statements, reducing
combinatorial complexity of extension-dependent VUs. Also fixes some
underspecified limits (such as pname:maxMipLevels) in the VUs for
slink:VkImageCreateInfo when
slink:VkExternalMemoryImageCreateInfo::pname:externalMemoryHandles
contains multiple bits, and fixes incorrectly (and underspecified)
limits when an Android external format is used (internal issue 1370).
* Remove unused "`Fragment Area Granularity`" glossary entry accidentally
introduced in the 1.1.85 update.
New Extensions:
* `VK_KHR_driver_properties`
* `VK_KHR_shader_atomic_int64`
* The specification sources contain text for another extension,
`VK_EXT_image_drm_format_modifier`, but this extension is not yet
complete, and is marked disabled in `vk.xml`. The extension will be
enabled, and become part of the spec, only when the authors decide it is
ready.
* Update release number to 85.
Public Issues:
* Add self-dependency ename:VK_DEPENDENCY_BY_REGION_BIT valid usage
statements for slink:VkSubpassDependency(public pull request 778).
* Apply fix from pull request 742 to slink:VkSubpassDependency and
slink:VkSubpassDependency2 (public pull request 779).
* Specify the units of slink:VkBufferImageCopy::pname:bufferRowLength and
pname:bufferImageHeight as texels (public pull request 781).
* Better specify promoted parameter mapping in the
`<<VK_KHR_create_renderpass2>>` appendix (public pull request 782).
Internal Issues:
* Only include the <<fundamentals-validusage-versions, Valid Usage for
Newer Core Versions>> section in Vulkan 1.1 or later (internal issue
1381).
Other Issues:
* Clean up redundant valid usage language for the
`VK_ANDROID_external_memory_android_hardware_buffer` extension
interaction with slink:VkImageCreateInfo.
* Fix error in a flag name within valid usage statements for
slink:VkMemoryAllocateInfo.
* Clarify that memory types are not totally ordered in
slink:VkPhysicalDeviceMemoryProperties.
* For slink:VkWriteDescriptorSetInlineUniformBlockEXT, set
structextends="VkWriteDescriptorSet" in `vk.xml`, and make
slink:VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::pname:pBindingFlags
optional.
* Add documentation of 'provisional' XML attribute to registry.txt.
New Extensions:
* `VK_NV_compute_shader_derivatives`
* `VK_NV_corner_sampled_image`
* `VK_NV_fragment_shader_barycentric`
* `VK_NV_mesh_shader`
* `VK_NV_representative_fragment_test`
* `VK_NV_scissor_exclusive`
* `VK_NV_shader_image_footprint`
* `VK_NV_shading_rate_image`
* `VK_NVX_raytracing`
* Update release number to 84.
Public Issues:
* Fix code sample in the `<<VK_EXT_debug_utils>>` extension (public issue
751).
* Fix misleading comment in `vk.xml` for
slink:VkDescriptorBufferInfo::pname:buffer (public pull request 762).
* Fix formatting of deprecation attributes in schema doc (public pull
request 767).
* Change `can` to `may` in the description of
elink:VkSparseImageFormatFlagBits, which are return values from queries
(public pull request 768).
* Prettify generated contact list in extension appendices, adding logos
and a New Issue link (public pull request 770).
* Enable sRGB conversion based on the image view format, not the image
format, in the <<textures-format-conversion, Format Conversion>> section
(public pull request 773).
* Fix typo in equation in the <<primsrast-lines-basic, Basic Line Segment
Rasterization>> section (public pull request 780).
* Fix special characters in GitHub contacts links (public pull request
783).
* Make clean_pdf target remove pdf folder (public pull request 784).
* Fix styleguide bad markup of block continuation (public pull request
792).
Other Issues:
* Allow a zero vertex attribute divisor in the
`<<VK_EXT_vertex_attribute_divisor>>` extension, exposed via the
slink:VkPhysicalDeviceVertexAttributeDivisorFeaturesEXT feature.
* Add missing `structextends="VkDeviceCreateInfo"` to
slink:VkPhysicalDeviceShaderDrawParameterFeatures and
slink:VkPhysicalDeviceBlendOperationAdvancedFeaturesEXT.
New Extensions:
* `VK_KHR_memory_model`
* `VK_EXT_astc_decode_mode`
* `VK_EXT_inline_uniform_block`
* Update release number to 83.
Public Issues:
* Use [%inline] directive for all SVGs to reduce file size (public pull
request 734).
* Convert XML `value` aliases into \<alias> tags (public pull request
747).
* Fix metadoc script showing non-selected extensions (public pull request
748).
* Reapply public pull request 742 to make
ename:VK_PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT part of the
graphices pipeline (public pull request 749).
* Fix numerous typos related to accidental duplication of words (public
pull request 760).
* Fix `vk.xml` contact typos (public pull request 761).
Internal Issues:
* Add images to the <<Standard sample locations>> table (internal issue
1115).
* Add a definition of "`Inherited from`" precision in the
<<spirvenv-precision-operation, Precision and Operation of SPIR-V
Instructions>> section (internal issue 1314).
* Clarify that both built-in and user-defined variables count against the
location limits for shader interfaces in the
<<interfaces-iointerfaces-locations, Location Assignment>> section
(internal issue 1316).
* Merge "`required`" capabilities into the <<spirvenv-capabilities-table,
list of optional: SPIR-V capabilities>> (internal issue 1320).
* Relax the layout matching rules of descriptors referring to only a
single aspect of a depth/stencil image, by reference to the new
<<resources-image-layouts-matching-rule, Image Layout Matching Rules>>
section (internal issue 1346).
* Revert extension metadoc generator warning about name mismatches to a
diagnostic, due to annoying warnings in build output for conscious
choices we've made (internal issue 1351).
Other Issues:
* Reserve bits for pending vendor extensions.
* Make Vulkan consistent with SPIR-V regarding code:DepthReplacing and
code:FragDepth in the <<interfaces-builtin-variables, Built-In
Variables>> section.
* Add missing ChangeLog entries for the previous three spec updates.
* Update release number to 79.
Public Issues:
* Add a note to the <<features-required-format-support, Required Format
Support>> section clarifying that the required formats don't depend on
the used flags (public issue 671).
* Add a valid usage statement for flink:vkUpdateDescriptors that was
previously described for slink:VkImageSubresourceRange, but not as a
valid usage statement (public issue 713).
* Modify implicit valid usage generator script to not emit 'must: not be
0' for a parameter that is a pointer to a flags field, such as
pname:pPeerMemoryFeatures (public issue 729).
Internal Issues:
* Add definitions of "`obsoleted`" and "`deprecated`", and modify the
definition of "`promoted`" in the <<glossary, Glossary>> (internal issue
988).
* Add language for integer texel output conversions (the conversion is
undefined) to the <<textures-output-format-conversion]] Texel Output
Format Conversion>> section. Simplify and clarify the floating-point
conversion language in the <<fundamentals-general, General
Requirements>> section and the new <<fundamentals-fp-conversion,
Floating-Point Format Conversions>> section, and remove obsolete
language in the format-specific floating-point sections (internal issue
1275).
* Add the elink:VkVendorId enumerated type to the Vulkan API / XML /
header, so reserved Khronos vendor IDs can be referred to symbolically
by clients. Note that only Khronos vendor IDs (e.g. non-PCI vendor IDs)
are defined (internal issue 1299).
* Fix typo in the <<fig-non-strict-lines, Non strict lines>> table
(internal issue 1315).
* Clean up and simplify the
<<features-formats-requiring-sampler-ycbcr-conversion, YCbCr format
properties>> table and use symbols consistently with other tables. Add a
column for the number of planes.
* Add code:Float16 to the <<spirvenv-capabilities-table, List of optional
SPIR-V capabilities>> for the `VK_AMD_gpu_shader_half_float` extension.
* Update release number to 74.
Github Issues:
* Clarify which buffer locations are accessed in
flink:vkCmdCopyBufferToImage valid usage statements (public issue 676).
* Refine description of <<extended-functionality-extensions-dependencies,
extension dependencies>>, related NOTE in the
<<extended-functionality-extensions, Extensions>> section, and
"`Required Extensions`" glossary term (public pull request 693).
* Add support for specifying required Vulkan core version in `vk.xml` and
the extension metadoc generator (public issue 696).
* Update .gitignore for directory reorganization (public pull request
699).
* Fix typo (public pull request 703).
Internal Issues:
* Update valid usage of slink:VkClearRect::pname:layerCount (internal
issue 1241).
Other Issues:
* Fix typo in <<NV_geometry_shader_passthrough>> issues list.
* Update release number to 73.
Github Issues:
* Refine swapchain association with surface for slink:VkSwapchainKHR, with
matching valid usage statements for slink:VkSwapchainCreateInfoKHR and
discussion following the <<swapchain-wsi-image-create-info>> table
(public issue 637).
* Re-remove several valid usage statements from slink:VkImageCreateInfo
that had previously been removed at the time that
ename:VK_IMAGE_CREATE_EXTENDED_USAGE_BIT was introduced. These
statements had incorrectly been restored due to an glitch while merging
from the old `1.0` branch to the current `master` branch (public issue
683).
Internal Issues:
* Fix reference page generation and configure build to generate reference
pages 1.1 with all extensions, rather than core only, as was the case
for the 1.0 ref pages (internal issues 484, 1056, 1205).
* Require that
slink:VkMemoryDedicatedRequirements::pname:prefersDedicateAllocation is
ename:VK_TRUE when
slink:VkMemoryDedicatedRequirements::pname:requiresDedicateAllocation is
ename:VK_TRUE (internal issue 1222).
* Fix Ruby extension code so `diff_html` Makefile target works (internal
issue 1230).
* Update `genRelease` script to generate 1.1 + all extensions reference
pages - but not the single-page HTML / PDF versions, which are even
larger than the API spec (internal issue 1245).
Other Issues:
* Add missing attributes to `vk.xml` for `VK_ANDROID_native_buffer`.
* Specify that the slink:VkAttachmentDescription::pname:format member is
the format of the image *view* that will be used for the attachment.
* Use core sname:VkPhysicalDeviceFeatures2 in the `structextends` `vk.xml`
attribute for sname:VkPhysicalDeviceDescriptorIndexingFeaturesEXT and
sname:VkPhysicalDeviceDescriptorIndexingPropertiesEXT, rather than the
KHR equivalent it was promoted from.
* Fix the "`Fragment Input Attachment Interface`" glossary entry to match
the specification body.
* Clarify the interaction of sRGB images used as storage or texel buffers
with <<textures-output-format-conversion, Texel Output Format
Conversion>>.
* Moved three valid usage statements from
slink:VkRenderPassMultiviewCreateInfo up to
slink:VkRenderPassCreateInfo, and added a new valid usage statement for
slink:VkRenderPassInputAttachmentAspectCreateInfo.
* Added valid usage statements for slink:VkBufferMemoryBarrier and
slink:VkImageMemoryBarrier reflecting the global requirement that
"`non-sparse resources must be bound to memory before being recorded to
command`".
New Extensions:
* Update release number to 72.
Github Issues:
* Restructure the repository to put the specification `Makefile` and
associated spec source material at the top level, `vk.xml` and
associated scripts material in `xml/`, and generated include and source
files in `include/vulkan/` and `src/ext_loader/`, respectively (public
issue 436).
* Add missing bullet point markup to flink:vkCmdCopyImage valid usage
statement, so it gets a VUID assigned (public issue 627).
* Fix broken links in a couple of extension appendices (public pull
request 665).
* Add the \<platform> tag to the index in section 4.1 of the registry
schema documentation, and add the protect= attribute of \<extension>
tags to the comments in `registry.rnc` (public issues 673, 678).
* Add missing valid usage statements for sparse image interactions to
flink:VkImageCreateInfo (public pull request 675).
* Fix improper usage and grammar of "`can: not`" (public pull request
681).
* Remove duplicate spec language and NOTE on present layout between the
flink:vkAcquireNextImageKHR and flink:vkAcquireNextImage2KHR commands
(public pull request 685).
* Fix some typos and markup issues (public pull request 689; public issues
642, 667, 687).
* Fix typo etext:VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_FENCE_FD_BIT ->
ename:VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT in the
<<external-semaphore-handle-types-compatibility, External semaphore
handle types compatibility>> table (public pull request 691).
Internal Issues:
* Remove the need for the "`noautovalidity`" attribute on extension
structures in `vk.xml`. It is now implied by the "`structextends`"
attribute instead (internal issue 942).
* Replace uses of "`currently bound`" with "`bound`", since "`currently`"
is redundant and distracting, and add a corresponding rule to the style
guide (internal issue 993).
* Fixed subtle issues with the last updates to flink:vkAcquireNextImageKHR
language that had resulted in ambiguities (internal issue 1178).
* Make it clear that only one query of a given type is allowed at a time
by reordering valid usage statements for flink:vkCmdBeginQuery and
flink:vkCmdEndQuery, and removing redundant ones (internal issue 1213).
* Swapped OL1 and OL3 in `tessparamUL.svg` to match previous version, and
fixed where "`(no edge)`" appears (internal issue 1215).
Other Issues:
* Fixed a minor problem with the valid usage statement extraction script,
and corresponding markup in the spec source.
New Extensions:
* `VK_AMD_shader_core_properties`
* `VK_EXT_descriptor_indexing`
* `VK_NV_shader_subgroup_partitioned`
* First public update for Vulkan 1.1.
Github Issues:
* Refer to standard sparse image block shape format tables explicitly in
the <<sparsememory-standard-shapes, Standard Sparse Image Block Shapes>>
section (public issue 93).
* Add the missing definition of the code:LocalInvocationIndex decoration
in the <<interfaces-builtin-variables, Built-In Variables>> section
(public issue 532).
* Clarify dynamic state definition in the introduction to the <<pipelines,
Pipelines>> section and the new <<pipelines-dynamic-state, Dynamic
State>> subsection (public issue 620).
* Clarified deprecation statement in the `VK_AMD_negative_viewport_height`
appendix (public issue 674).
* Fix parameter descriptions for flink:vkCreateIndirectCommandsLayoutNVX
(public issue 677).
Internal Issues:
* Remove description of <<primsrast-points, rasterization point size>>
being taken from the tessellation control shader, since there are no
circumstances under which you can have TCS without TES (internal issue
522).
* Define <<copies-images-format-size-compatibility, _size-compatible_
image formats>> for flink:vkCmdCopyImage, add it to the glossary, and
use that definition for slink:VkImageViewCreateInfo (internal issue
771).
* Change brief descriptions of enumerant names, and of parameters which
are enumerants, from "`enum *indicates*`" to "`enum *specifies*`" for
consistency, and add a markup style guide rule (internal issue 862).
* Clarify how execution dependencies interact with
<<synchronization-submission-order, submission order>> at numerous
places in the <<renderpass, Render Pass>> and <<synchronization,
Synchronization>> chapters (internal issue 1062).
* Clarify statement in the <<interfaces-resources-setandbinding,
DescriptorSet and Binding Assignment>> section that only interface
variables statically used by the entry point used in a pipeline must be
present in the descriptor set layout (internal issue 1172).
* Flip sparse image diagrams with partially full mip levels vertically, to
match graph origins of other image diagrams (internal issue 1176).
* Update new SVG diagrams to have consistent style and base font size,
increase consistency of primitive topology diagrams, and add a section
to the style guide on creating and editing images in a consistent style
(internal issue 1177).
* Resolve problems with valid usage statement extraction by fixing
existing VUID tags for interfaces promoted to version 1.1 and fixing
conditional directives around
VUID-VkMemoryDedicatedAllocateInfo-image-01797 (internal issue 1184).
* Strip `KHR` suffixes from a few interfaces promoted to Vulkan 1.1 that
were missed previously (internal issue 1185).
* Restrict code:OpImageQuerySizeLod and code:OpImageQueryLevels to only
work on code:Image operands with their code:Sampled operand set to 1. In
other words, these operations are not defined to work with storage
images (internal issue 1193).
* Recycle extension slot for extension #82 in `vk.xml`. This extension was
never published (internal issue 1195).
* Add an issue to the `VK_KHR_maintenance1` appendix noting that zero
height viewports are allowed when this extension is enabled (internal
issue 1202).
* Fix slink:VkDescriptorSetLayoutBinding description so that shader stages
always use descriptor bindings, not the other way around (internal issue
1206).
* Fix field name for
slink:VkInputAttachmentAspectReference::pname:inputAttachmentIndex
(internal issue 1210).
Other Issues:
* Fix a few broken links in the <<versions-1.1, Version 1.1>> appendix.
* Replace a few old refBegin/refEnd tags with open block markup around
interfaces, and remove old KHX VUID tags that were breaking the valid
usage statement extraction.
* Fix error codes accidentally tagged as success codes in `vk.xml` for
flink:vkGetSwapchainCounterEXT.
* Added valid usage statements for ftext:vkBind*Memory2 input structures
stext:VkBind*MemoryInfo, and fix a pname:image -> pname:buffer typo in a
couple of places.
* Fix swapped descriptions of elink:VkDescriptorType enums
ename:VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE and
ename:VK_DESCRIPTOR_TYPE_STORAGE_IMAGE (reported via tweet).
New Extensions:
* `VK_ANDROID_external_memory_android_hardware_buffer`
* Vulkan 1.1 initial release. Bump API patch number and header version
number to 70 for this update. The patch number will be used for both
Vulkan 1.1 and Vulkan 1.0 updates, and continues to increment
continuously from the previous Vulkan 1.0.69 update.
NOTE: We are not publishing an updated 1.0.70 specification, or 1.1
reference pages, along with 1.1.70. There are still minor issues to work
out with those build targets. However, we will soon generate all three
types of documents as part of the regular spec update cycle.
NOTE: The GitHub KhronosGroup/Vulkan-Docs repository now maintains the
current specification in the `master` branch. The `1.0` branch is out of
date and will not be maintained, since we will be generating both 1.1
and 1.0 specifications from the `master` branch in the future.
Github Issues:
* Clarify how mapped memory ranges are flushed in
flink:vkFlushMappedMemoryRanges (public issue 127).
* Specify that <<synchronization-pipeline-stages, Pipeline Stages>> are a
list of tasks that each command performs, rather than necessarily being
discrete pieces of hardware that one task flows through. Add a
"`synchronization command`" pipeline type which all synchronization
command execute (it's just TOP + BOTTOM), with an explanatory note
(public issue 554).
Internal Issues:
* Regenerate all images used in the spec in Inkscape with a consistent
look-and-feel, and adjust image size attributes so they're all legible,
and not too large with respect to the spec body text (internal issue
701).
* Document in the <<extensions,extensions>> appendix and in the style
guide that `KHX` extensions are no longer supported or used in the
Vulkan 1.1 timeframe (internal issue 714).
* Remove the leftover equations_temp directory after PDF build completes
(internal issue 925).
* Update the <<credits, Credits (Informative)>> appendix to include
contributors to Vulkan 1.1, and to list them according to the API
version(s) they contributed to (internal issue 987).
* Add a NOTE to the introduction explaining that interfaces defined by
extensions which were promoted to Vulkan 1.1 are now expressed as
aliases of the Vulkan 1.1 type (internal issue 991).
* Instrument spec source conditionals so spec can be built with 1.1
features, extensions promoted to 1.1, or both (internal issues 992,
998).
* Modify the XML schema and tools to support explicit aliasing of types,
structures, and commands, and use this to express the promotion of 1.0
extensions to 1.1 core features, by making the extension interfaces
aliases of the core features they were promoted to. Mark up promoted
interfaces to allow still generating 1.0 + extension specifications
(internal issue 991).
* Platform names, along with corresponding preprocessor symbols to enable
extensions specific to those platforms, are now reserved in vk.xml using
the <platform> tag. Update the registry schema and schema specification
to match (internal issue 1011).
* Updated the <<textures-texel-replacement, Texel Replacement>> section to
clarify that reads from invalid texels for image resources result in
undefined values (internal issue 1014).
* Modify description of patch version so it continues to increment across
minor version changes (internal issue 1033).
* Clarify and unify language describing physical device-level core and
extension functionality in the <<fundamentals-validusage-extensions,
Valid Usage for Extensions>>, <<fundamentals-validusage-versions, Valid
Usage for Newer Core Versions>>, <<initialization-functionpointers
Command Function Pointers>>, <<initialization-phys-dev-extensions,
Extending Physical Device From Device Extensions>>
<<extended-functionality-instance-extensions-and-devices, Instance
Extensions and Device Extensions>> sections and for
flink:vkGetPhysicalDeviceImageFormatProperties2. This documents that
instance-level functionality is tied to the loader, and independent of
the ICD; physical device-level functionality is tied to the ICD, and
associated with device extensions; physical devices are treated more
uniformly between core and extensions; and instance and physical
versions can be different (internal issue 1048).
* Updated the <<commandbuffers-lifecycle, Command Buffer Lifecycle>>
section to clarify the ability for pending command buffers to transition
to the invalid state after submission, and add a command buffer
lifecycle diagram (internal issue 1050).
* Clarify that some flink:VkDescriptorUpdateTemplateCreateInfo parameters
are ignored when push descriptors are not supported (internal issue
1054).
* Specify that flink:vkCreateImage will return an error if the image is
too large, in a NOTE in the slink:VkImageFormatProperties description
(internal issue 1078).
* Remove near-duplicate NOTEs about when to query function pointers
dynamically in the <<initialization, Initialization>> chapter and
replace by extending the NOTE in the <<fundamentals-abi, Application
Binary Interface>> section (internal issue 1085).
* Restore missing references to "`Sparse Resource Features`" in the
flink:VkBufferCreateFlagBits description (internal issue 1086).
* Tidy up definitions of descriptor types in the `GL_KHR_vulkan_glsl`
specification, the <<descriptorsets, Resource Descriptors>> section and
its subsections, and the <<interfaces-resources-descset, Descriptor Set
Interface>> for consistency, reduction of duplicate information, and
removal of GLSL correspondance/examples (internal issue 1090).
* Correctly describe code:PrimitiveId as an Input for tessellation control
and evaluation shaders, not an Output (internal issue 1109).
* Relax the requirements on chroma offsets for nearest filtering in
<<textures-implict-reconstruction, Implicit Reconstruction>> (internal
issue 1116).
Other Issues:
* Clarify the intended relationship between specification language and
certain terms defined in the Khronos Intellectual Property Rights
policy. Specific changes include:
** Rewrote IP/Copyright preamble and introduction to better agree with
normative language both as laid out in the introduction, and the
Khronos IPR policy.
** Added notion of fully informative sections, which are now tagged with
"`(Informative)`" in their titles.
** Removed non-normative uses of the phrase "`not required`"
** Clarified the distinction between terms "`optional`" and "`not
required:`" as they relate to the IPR Policy, and updated specification
text to use terms consistent with the intent.
** Reduced additions to RFC 2119, and ensured the specification agreed
with the leaner language.
** Removed the terms "`hardware`", "`software`", "`CPU`", and "`GPU`" from
normative text.
** Moved several paragraphs that should not have been normative to
informative notes.
** Clarified a number of definitions in the Glossary.
** Updated the document writing guide to match new terminology changes.
* Explicitly state in the <<fundamentals-objectmodel-lifetime-acquire,
application memory lifetime>> language that that for objects other than
descriptor sets, a slink:VkDescriptorSetLayout object used in the
creation of another object (such as slink:VkPipelineLayout or
slink:VkDescriptorUpdateTemplateKHR) is only in use during the creation
of that object and can be safely destroyed afterwards.
* Updated the <<textures-scale-factor, Scale Factor Operation>> section to
use the ratio of anisotropy, rather than the integer sample rate, to
perform the LOD calculation. The spec still allows use of the sample
rate as the value used to calculate the LOD, but no longer requires it.
* Update `vulkan_ext.c` to include all platform-related definitions from
the Vulkan platform headers, following the split of the headers into
platform-specific and non-platform-specific files.
* Fix bogus anchor name in the <<commandbuffers, Command Buffers>> chapter
which accidentally duplicated an anchor in the pipelines chapter. There
were no reference to this anchor, fortunately.
* Add valid usage statement for slink:VkWriteDescriptorSet and
slink:VkCopyDescriptorSet requiring that the slink:VkDescriptorSetLayout
used to allocate the source and destination sets must not have been
destroyed at the time flink:vkUpdateDescriptorSets is called.
* Document mapping of subgroup barrier functions to SPIR-V, and clarify a
place where subgroupBarrier sounds like it's execution-only in the
standalone `GL_KHR_shader_subgroup` specification.
* Use an HTML stylesheet derived from the Asciidoctor `colony` theme, with
the default Arial font family replaced by the sans-serif Noto font
family.
* Numerous minor updates to README.adoc, build scripts, Makefiles, and
registry and style guide specifications to support Vulkan 1.1 outputs,
use them as defaults, and remove mention of `KHX` extensions, which are
no longer supported.
New Extensions:
* `VK_EXT_vertex_attrib_divisor`
* Bump API patch number and header version number to 69 for this update.
Github Issues:
* Clean up description of synchronization for flink:vkAcquireNextImageKHR
(public issue 626).
* Move valid usage statements requiring offset and extent to respect image
transfer granularity requirements of the queue family they are submitted
against from slink:VkImageCopy and slink:VkBufferImageCopy to the
corresponding flink:vkCmdCopyImage, flink:vkCmdCopyBufferToImage, and
flink:vkCmdCopyImageToBuffer commands, where are relevant information is
known (public issue 654).
* Clarify that flink:vkGetDeviceProcAddr only supports device-level
commands (public issue 655).
Internal Issues:
* Associate each elink:VkDescriptorType with a type of descriptor, and
link to descriptions of those types (internal issue 860).
* Rework valid usage extraction script to better utilize and respond to
spec markup, and fix some spec markup accordingly (internal issues 846,
909, 945).
* Rephrase flink:vkCmdPushConstants valid usage to allow overlapping push
constant ranges in different shader stages (internal issue 1103).
* Fix problem with diff_html target in extension.rb (internal issue 1104).
* Modify valid usage statements for slink:VkClearDepthStencilValue,
slink:VkGraphicsPipelineCreateInfo, slink:VkViewport, and
flink:vkCmdSetDepthBounds, and the description of vkCmdSetDepthBias, to
clarify that clamping is applied if and only if the
`VK_EXT_depth_range_unrestricted` is not enabled (internal issue 1124),
in versions of the specification built with that extension included.
* Resolve contradictions and use of undefined "`per-sample shading`" term
in the <<primsrast-sampleshading, Sample Shading>> and
<<shaders-fragment-execution, Fragment Shader Execution>> sections; for
the <<features-features-sampleRateShading, sampleRateShading feature>>;
for code:FragCoord, code:SampleId, and code:SamplePosition; and for
slink:sname:VkPipelineMultisampleStateCreateInfo (internal issue 1134).
* Clarify the meaning of the ptext:maxDescriptorSet* limits in footnote 8
of the <<features-limits-required,Required Limits>> table (internal
issue 1139).
* Fix broken NOTE markup in slink:VkSamplerCreateInfo.txt (internal issue
1140).
* Remove extend comparison language from valid usage statement for
slink:VkImageCreateInfo, turning it into a simple validation of
pname:mipLevels against pname:maxMipLevels (internal issue 1151).
* Update valid usage statements for slink:VkImageCopy when the
`VK_KHR_maintenance1` extension is enabled to allow multi-slice 2D <->
3D copies when the pnaem:extent.depth parameter specifies the number of
layers being copied, and matches the
slink:VkImageSubresourceLayers.layerCount of the 2D image (internal
issue 1152).
* Rephrase memory / control barrier rules in the
<<spirvenv-module-validation, Validation Rules within a Module>> section
to avoid "`not use none`", which could be misconstrued to allow no
synchronization semantics, and only storage class semantics (internal
issue 1154).
Other Issues:
* Move GLSL extension specifications to the KhronosGroup/GLSL repository
on Github.
* Add missing description of ename:VK_FILTER_CUBIC_IMG enum to
slink:VkFilter.
* Update description of code:PrimitiveId in the
<<interfaces-builtin-variables,Built-In Variables>> section to clarify
its behavior.
* Disallow disjoint images from being used with dedicated-memory images in
slink:VkMemoryDedicatedAllocateInfoKHR.
* Update README to suggest older versions of "mathematical" and
"ruby-gems" packages for use on Cygwin.
* Fix typos
New Extensions:
* `VK_AMD_buffer_marker`
* Bump API patch number and header version number to 68 for this update.
Github Issues:
* Added more details in the
<<extended-functionality-extensions-compatibility, Extension
Compatibility>> section, allowing explicit incompatibilities, and
simplify corresponding language in the style guide, which now defers to
the API Specification on this point (public issue 638).
* Fix typo in description of slink:VkCommandBufferLevel::pname:level
(public issue 651).
* Only include extension-dependent valid usage statement for
slink:VkImageSubresourceRange, and note that the extension names for
header files described in the <<boilerplate-wsi-header, Window
System-Specific Header Control>> section are only valid links, when the
specification being viewed is built with the corresponding extensions
enabled (public issue 652).
Internal Issues:
* Add language to elink:VkResult specifying that when commands return an
error, output parameter contents are undefined instead of unmodified
(except for pname:sType and pname:pNext). Note that this is a behavior
change. Add notes calling out slink:VkImageFormatProperties as an
exception (internal issue 1118).
* Add "`general-purpose`" to the style guide, and correct existing uses of
"`general purpose`" as an adjective (internal issue 1121).
* Add the ename:VK_DEBUG_REPORT_OBJECT_TYPE_VALIDATION_CACHE_EXT_EXT token
for the `VK_EXT_validation_cache` extension, following the same naming
pattern as other tokens in the extension, but keep the old
ename:VK_DEBUG_REPORT_OBJECT_TYPE_VALIDATION_CACHE_EXT token around for
backwards compatibility (internal issue 1126).
Other Issues:
* Specify that flink:vkCmdSetDiscardRectangleEXT does not affect copies or
clears, matching existing language for the scissor rectangle test.
* Move the <<boilerplate-sType, pname:sType>> definition from the
boilerplate appendix to the Fundamentals chapter, putting it together
with the valid usage of pname:sType rather than having the definition
split across two places.
* Inline all of the etext:Vk*Flags definitions, moving each one from the
boilerplate appendix to appear either after the corresponding
etext:Vk*FlagBits value if one is defined, or after the first structure
that includes them if not.
* Bump API patch number and header version number to 67 for this update.
* Update copyright dates to 2018
Github Issues:
* Fix texture lookup functions in `GL_KHR_vulkan_glsl` specification
(public pull request 363).
* Clarify the state waited semaphores are left in when a call to
flink:vkQueuePresentKHR fails (public issue 572).
* Cleanup descriptions of slink:VkObjectTablePushConstantEntryNVX and
slink:VkObjectTableDescriptorSetEntryNVX (public issue 583)
* Remove redundant flink:vkCmdSetDiscardRectangleEXT valid usage
statements (public pull 586).
* Make dynamic state array length valid usage statements implicit for
flink:vkCmdSetViewportWScalingNV, flink:vkCmdSetDiscardRectangleEXT, and
flink:vkCmdSetViewport (public pull 589).
* Clarify meaning of window extent (0,0) in slink:VkSwapchainKHR for the
Windows and X11 platforms, in their respective extensions (public issue
590).
* Allow flink:vkGetPastPresentationTimingGOOGLE to return
ename:VK_INCOMPLETE (public issue 604).
* Add synchronization valid usage statements to flink:vkAcquireNextImage
(public pull 611).
* Fix some broken external links and internal xrefs (public pull 613).
* Clean up slink:VkViewport valid usage statements in the presence or
absence of relevant extensions (public pull 623).
* Remove
ename:VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR
token from VK_KHR_maintenance2 from the non-extension VU path for
slink:VkGraphicsPipelineCreateInfo (public issue 628).
* Miscellaneous minor markup fixes - extension name strings (public pull
631), Notes (pull 633), queue names emitted by generator scripts (pull
634), block formatting in slink:VkDescriptorUpdateTemplateEntryKHR (pull
635), ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG (pull
641), quotes and apostrophes (pull 643),
* Miscellaneous minor grammar fixes (public pull 644).
* Fix markup macros so usage like ptext:*Src* works (public pull 647).
Internal Issues:
* Clarify in the `VK_KHR_surface` and `VK_KHR_swapchain` extensions that
parameter combinations which aren't supported for normal images are also
unsupported for presentable images, even if the parameter values are
individually supported as reported by the surface capability queries
(internal issue 1029).
* Fixed XML typo in the valid value field of the pname:sType member of
slink:VkPhysicalDeviceExternalMemoryHostPropertiesEXT (internal issue
1100).
Other Issues:
* Add memory semantics validity rules to the <<spirvenv-module-validation,
Validation Rules within a Module>> section of the SPIR-V environment
appendix, and specify that sequentiality consistency is not supported.
This forbids certain cases like "`Load+Release`" that we don't expect to
ever be meaningful.
* Document mapping of OpenGL Shading Language barriers to SPIR-V scope and
semantics in the `GL_KHR_vulkan_glsl` specification.
New Extensions:
* `VK_EXT_conservative_rasterization`
* Bump API patch number and header version number to 66 for this update.
Github Issues:
* Clarified how and when ename:VK_ERROR_TOO_MANY_OBJECTS is generated in
flink:vkAllocate Memory, and remove incorrect valid usage statement
about exceeding the API limit (public issue 356).
* Minor clarification of the description of
flink:vkUpdateDescriptorSetWithTemplateKHR::pname:descriptorUpdateTemplate
(public issue 564).
* Minor fixes for flink:vkCmdSetViewportWScalingNV (public pull request
588).
* Fix random name markup issues (public pull request 603).
* Fix code:BuiltIn decoration typo in the <<fxvertex-attrib, Vertex
Attributes>> section (public pull request 606).
* Fix synchronization language following the definition of
flink:vkAcquireNextImageKHR (public issue 607).
* Restore descriptions of several commands and structures missing from the
generated spec due to a mistyped asciidoctor conditional (public issue
612).
* Fix 1.0.41 changelog to refer to public issues 403/404 (public issue
618).
Internal Issues:
* Refactor valid usage statements with internal conditionals in
`copies.txt`, `pipelines.txt`, `renderpass.txt`, and `resources.txt` so
each branch of the conditional appears as a standalone statement which
can contain a separate VUID. This should have no impact on the generated
specs, but is necessary given the present state of the VU extractor and
the validation layer code that consumes them (internal issue 1043).
* Fix VkQueueGlobalPriorityEXT enum values missing _EXT suffix (internal
issue 1045).
* Clarified initial ownership of resources bound to shared memory objects,
(internal issue 1068).
* Fix duplicated valid usage ID tag for flink:vkCmdCopyImage, and make the
required layouts include ename:VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIONAL in
both cases (internal issue 1084).
Other Issues:
* Remove the noise functions from GLSL for SPIR-V for Vulkan in the
`GL_KHR_vulkan_glsl.txt` extension.
New Extensions:
* `VK_EXT_external_memory_host`
* `VK_EXT_external_memory_dma_buf`
* `VK_EXT_queue_family_foreign`
- add missing `*name` and `*link` and `code`
- change where wrong macro was used
- swap `*name` and `*link` where appropriate
- correct misspelled names
- that sort of thing...
* Bump API patch number and header version number to 63 for this update.
Github Issues:
* Add missing valid usage statements for ptext:maxDescriptorSets*,
ptext:maxPerStageDescriptorInputAttachments, and
ptext:maxPerStageResources to slink:VkPipelineLayoutCreateInfo.txt,
flink:VkComputePipelineCreateInfo, and
flink:VkGraphicsPipelineCreateInfo (public issue 546).
* Fix typos in ftext:vkCmdDraw*AMD descriptions (public pull request 549).
* Fixed flink:vkCmdWriteTimestamp so it is not unnecessarily restricted to
queues supporting graphics or compute operations (public issue 558).
* Improvements to valid usage generator for output `*Flags` pointer
parameters and for some `void *` parameters (public pull requests 560,
562).
* Document `altlen` attribute in XML schema as valid C99 syntax and tweak
`vk.xml` to match (public pull request 566).
* Clarify when pname:fence is signaled by flink:vkQueueSubmit in a more
obvious place (public issue 577).
Internal Issues:
* Specify a whitelist of supported SPIR-V Storage Classes in the
<<spirvenv-module-validation, Validation Rules within a Module>>
appendix (internal SPIR-V issue 166).
* Relax the shared semaphore wait timeout requirement in the
<<synchronization-semaphores-importing, Importing Semaphore Payloads>>
section (internal issue 820).
* Update the <<textures-image-level-selection, Image Level(s) Selection>>
equations so that the parameters returned by the level-of-detail query
appear explicitly, also fixing the issue that linear filtering would
select a level below the base level for magnification (internal issue
926).
* Disallow creation of a swapchain with zero pname:imageExtent in
slink:VkSurfaceCapabilitiesKHR and slink:VkSwapchainCreateInfoKHR
(internal issue 1020).
Other Issues:
* Clarify in <<textures-operation-validation,Image View Validation>> that
the layout of subresources in an image view must have a layout that
matches that written into the descriptor, and that this section is about
validating image views, not images.
New Extensions:
* `VK_EXT_global_priority`
* Bump API patch number and header version number to 62 for this update.
Github Issues:
* Move asciidoc conditionals for `VK_KHR_maintenance1` in
slink:VkDescriptorSetAllocateInfo so valid usage statements for
`VK_KHR_push_descriptor` aren't accidentally removed when the first
extension isn't enabled (public issue 573).
* Fixed errors in API example code for
flink:vkUpdateDescriptorSetWithTemplateKHR and
flink:vkCmdPushDescriptorSetWithTemplateKHR (public issue 577).
Internal Issues:
* Specify constraints on concurrent access to fences that share payload in
the <<synchronization-fences-importing, Importing Fence Payloads>> and
<<synchronization-semaphores-waiting-state, Semaphore State Requirements
For Wait Operations>> sections (internal issue 820).
* Define the term "`retired swapchain`", reorganize some swapchain
language, and improve language for pname:oldSwapchain in
flink:VkSwapchainCreateInfoKHR, the <<swapchain-wsi-image-create-info>>
table, flink:vkDestroySwapchainKHR, and flink:vkAcquireNextImage2KHX
(internal issue 869).
* Describe in the <<writing-arrays, Describing Properties of Array
Elements>> section of the style guide how and when to use "`each`" and
"`any`" to refer to properties of array elements, and make those uses in
the specification consistent (internal issue 884).
* Clarified that events cannot be used for cross-queue synchronization in
the <<synchronization-events, Events>> section and for
flink:vkCmdWaitEvents (internal issue 970).
* Add success and error codes to +vk.xml+ for
flink:vkCreateValidationCacheEXT (internal issue 995).
* Clarify aspect mask usage for image memory barriers of multi-plane
images in slink:VkImageSubresourceRange, slink:VkImageMemoryBarrier, and
the <<textures-layout-validation, Layout Validation>> section (internal
issue 996).
Other Issues:
* Fixed typo in flink:VkRenderPassSampleLocationsBeginInfoEXT (renamed
field pname:pSubpassSampleLocations to
pname:pPostSubpassSampleLocations).
* Add missing buffer usage requirements for indirect draws in
flink:vkCmdDrawIndirect, flink:vkCmdDrawIndirectCountAMD,
flink:vkCmdDrawIndexedIndirect, and
flink:vlCmdDrawIndexedIndirectCountAMD.
* Modify Makefile to allow specification to build in git "`detached HEAD`"
state.
* Update valid usage ID generation script to allow recursively operating
on all `.txt` files in a specified directory, and move the `startVUID`
tracking information into a separate python file that is automatically
updated by the script.
New Extensions:
* Add +vk.xml+ entries for pending `VK_ANDROID_native_buffer` extension
(note, this extension is not yet enabled).
* `VK_AMD_shader_image_load_store_lod`
* Bump API patch number and header version number to 61 for this update.
Github Issues:
* Provide alternate length attributes (altlen=) in the XML schema, for
those using length attributes to generate code instead of documentation
(public issue 555).
* Fix erroneous references to `latex:` being used for asciidoc math
markup, rather than `latexmath:` (public pull request 556).
* Add author ID to XML for Kazan software renderer (public pull request
557).
Internal Issues:
* Add the <<fundamentals-abi,Application Binary Interface>> section
describing platform ABI requirements and recommendations, add examples
of function and function pointer declarations to the
<<boilerplate-platform-specific-calling-conventions, Platform-Specific
Calling Conventions>> section, and remove related language that existed
elsewhere in the specification (internal issue 64).
* Describe where to document valid usage interactions of chained
structures in the style guide, and fix one case now appearing in
slink:VkBufferCreateInfo instead of the child
slink:VkDedicatedAllocationBufferCreateInfoNV structure (internal issue
715).
* Add example to the style guide of describing enumerated types which are
empty when the spec is built without relevant extensions enabled, and
apply it to existing examples for
elink:VkDescriptorSetLayoutCreateFlagBits and
elink:VkSubpassDescriptionFlagBits (internal issue 864).
* Add a note to the <<fundamentals-validusage-enums, Valid Usage for
Enumerated Types>> section that the special values suffixed with
etext:_BEGIN_RANGE, etext:_END_RANGE, etext:_RANGE_SIZE and
etext:_MAX_ENUM are not part of the API and should: not be used by
applications (internal issue 872).
* Added note to flink:vkCmdUpdateBuffers explaining the performance
penalty for copies done in this way, and why the upper copy limit is
what it is (internal issue 952).
* Update `VK_KHX_device_group` to split some functionality into the new
`VK_KHR_bind_memory2` extension, and rename that functionality (internal
issue 969).
* Remove *Status* fields from extension appendices, since they are by
definition published and complete by the time they reach the public
github repository (internal issue 973).
Other Issues:
* Update Data Format specification dependency to version 1.2 and change
references to DF sections accordingly.
* Update XML to make the pname:pAllocator parameter of
flink:vkRegisterDeviceEventEXT and flink:vkRegisterDisplayEventEXT in
the `VK_EXT_display_control` extension as optional.
New Extensions:
* `VK_KHR_bind_memory2`
* `VK_KHR_image_format_list`
* `VK_KHR_maintenance2`
* `VK_KHR_sampler_ycbcr_conversion`
* Bump API patch number and header version number to 59 for this update.
Github Issues:
* Fix a few missing Implicit Valid Usage statements to indicate that a
common parent of two objects is required (public issue 497).
* Clarify render pass synchronization language for
slink:VkSubpassDependency and \<\<renderpass,render passes>> (public
issue 531).
* Rename ename:VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES2_EXT to
ename:VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT for consistency, and
add an alias for backwards compatibility (public issue 539).
Internal Issues:
* Add an explanation to the \<\<interfaces-builtin-variables-layer,
code:Layer>> description explaining that writing to invalid layers
results may or may not result in primitives being processed and fragment
shaders being run, and gives undefined results in the framebuffer
(internal issue 614)
* Add valid usage statement for slink:VkDescriptorSetLayoutBinding
requiring that input attachment descriptor bindings must not use
non-fragment stages (internal issue 933).
Other Issues:
* Makes description of pname:loadOp and pname:storeOp easier to read in
the \<\<renderpass-load-store-ops>> section.
New Extensions:
* `VK_EXT_shader_stencil_export`
* Bump API patch number and header version number to 58 for this update.
Github Issues:
* Update the <<interfaces-resources-descset,Descriptor Set Interface>>
section to allow multiple variables with the same descriptor set/binding
decorations, and require that all variables that are statically used
must be consistent with the pipeline layout. Allow
ename:VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER to be used with texture
and sampler variables (public issues 522, 524).
Internal Issues:
* Replace networkx package used for extension dependency generation with a
homegrown network dependency traverser (internal issue 713).
* Specify in the <<interfaces-fragmentoutput, Fragment Output Interface>>
section that if a fragment shader writes integers that cannot be
represented in the format of the colour attachment, then the result is
undefined (internal issue 893).
* Separate malformed valid usage statement for
slink:VkPipelineRasterizationStateCreateInfo into two (internal issue
918).
* Fix cases where the term 'pNext chain' is incorrectly used in reference
to functions, rather than their parameters. Replace 'pNext list' with
'pNext chain'. Fixed typo in the example code of
+VK_KHR_dedicated_allocation+ (internal issue 944).
* Fix typo in elink:VkExternalSemaphoreHandleTypeFlagBitsKHR enum
descriptions, replacing
etext:VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_FENCE_FD_BIT_KHR with
ename:VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_SYNC_FD_BIT_KHR, and make the
description more consistent with
VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT_KHR (internal issue 950).
Other Issues:
* Clarify how pipeline stage masks affect
<<synchronization-pipeline-stages-masks, access and synchronization
scopes>>.
* Clarify that dedicated allocations do not allow aliasing in the
flink:vkBindBufferMemory and flink:vkBindImageMemory valid usage
statements.
* Correct specification of pname:dynamicCount for push_constant token in
slink:VkIndirectCommandsLayoutNVX.
New Extensions:
* `VK_EXT_shader_viewport_index_layer`
* Bump API patch number and header version number to 57 for this update.
Github Issues:
* Fix error in description of ename:VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK
block size (public issue 342).
* Update documentation of ename:VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT
to explicitly mention both graphics and compute pipelines (public issue
525).
Internal Issues:
* Document that
slink:VkPhysicalDeviceLimits::pname:framebufferColorSampleCounts does
not cover integer formats (internal issue 550).
* Add a note under slink:VkImageViewCreateInfo describing how values meant
for one format can be sanitized when used via another format (internal
issue 927).
* Add valid usage statements to ftext:vkCmd* documenting that image
subresources used as attachments must not be accessed as non-attachments
in a render pass (internal issue 929).
* Remove obsolete 'validextensionstructs' attribute from +vk.xml+, the XML
schema, and the schema documentation (internal issue 946).
New Extensions:
* `VK_AMD_mixed_attachment_samples`
* `VK_EXT_post_depth_coverage`
* `VK_KHR_relaxed_block_layout`
* `VK_NV_depth_range_unrestricted`
* Bump API patch number and header version number to 55 for this update.
Github Issues:
* Removed unintended optional parameter in +vk.xml+ from the
pname:pWaitSemaphores member of slink:VkPresentInfoKHR, which resulted
in the generation of an incorrect implicit valid usage clause allowing
pname:pWaitSemaphores to be NULL even when pname:waitSemaphoreCount is
non-zero (public issue 491).
* Add missing attribute to +vk.xml+ documenting that
slink:VkSwapchainCounterCreateInfoEXT extends
slink:VkSwapchainCreateInfo (public issue 510).
* Add const qualifier for some `VK_EXT_debug_market` extension command
parameters that were missing it (public issue 513).
* Fix definition of q and level~base~ in
<<textures-image-level-selection,Image Level(s) Selection>> (public
issue 515).
* Clarify lifetime requirement for slink:VkRenderPass objects used in
object creation (public issue 516).
* Fix link to floating/normalized fixed-point conversion from
<<interfaces-fragmentoutput,Fragment Output Interface>> (public issue
521).
Internal Issues:
* Update the style guide to include the general structure of a Vulkan
command name, the specific rule for using "`Get`" vs. "`Enumerate`" in
names, and a table of verbs commonly used in command names (spinoff of
internal issue 753).
* Clarified the behavior of automatic layout transitions in case of
attachment views that are 2D or 2D array views of 3D images. In
addition, restructured the valid usage clauses corresponding to the
members of the slink:VkImageSubresourceRange structure and added missing
valid usage clauses for its pname:baseMipLevel and pname:baseArrayLayer
members (internal issues 803, 849).
* Modify `GL_KHR_vulkan_glsl` specification to allow explicit std430 on a
push_constant declaration (internal issue 919).
Other Commits:
* Modify <<synchronization-framebuffer-regions, Framebuffer Region
Dependencies>> to use synchronization scope terminology.
* Add ename:VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT to the
`VK_EXT_swapchain_colorspace` extension.
* Replace XML comments with `comment` attributes and/or tags, to enable
tools which transform the XML without loss of information.
* Replace `validextensionstructs` with `structextends`, which is tagged in
the child structure instead of the parent. This makes it slightly
simpler to add new structs to the XML, causes fewer merge conflicts, and
the information is kept localized to the extension structures where it
belongs. The old `validextensionstructs` attributes will be retained
until we're certain this doesn't cause problems with known consumers of
+vk.xml+.
* Bump API patch number and header version number to 54 for this update.
Github Issues:
Internal Issues:
* Fix tessellation domain to have an upper-left origin in the
<<img-tessellation-topology-ul, tessellation toplogy image>> and related
language. CTS and all implementations were already doing this, it was
just a documentation bug that it was flipped to lower-left (internal
issue 603).
* Add a section to the style guide describing how VUID tags are changed
and removed when the corresponding Valid Usage statements are modified
(internal issue 829).
* Add explicit Valid Usage statement to
slink:VkPipelineDynamicStateCreateInfo to require that members of
pname:pDynamicStates must be unique (internal issue 851).
New Extensions:
* `VK_KHR_16bit_storage`
* `VK_KHR_dedicated_allocation`
* `VK_KHR_external_fence`
* `VK_KHR_external_fence_capabilities`
* `VK_KHR_external_fence_fd`
* `VK_KHR_external_fence_win32`
* `VK_KHR_get_memory_requirements2`
* `VK_KHR_storage_buffer_storage_class`
* `VK_KHR_variable_pointers`
Extensions Promoted From KHX To KHR Status:
* `VK_KHR_external_memory`
* `VK_KHR_external_memory_capabilities`
* `VK_KHR_external_memory_fd`
* `VK_KHR_external_memory_win32`
* `VK_KHR_external_semaphore`
* `VK_KHR_external_semaphore_capabilities`
* `VK_KHR_external_semaphore_fd`
* `VK_KHR_external_semaphore_win32`
* `VK_KHR_win32_keyed_mutex`
* Bump API patch number and header version number to 53 for this update.
Github Issues:
Internal Issues:
* Clarify mappings of coordinates for mutable, compatible image views in
slink:VkImageViewCreateInfo (internal issue 815).
* Make ename:VK_BIND_SFR_BIT require a logical device with multiple
physical devices, so that standard sparse image block dimensions are
only required on systems that support multi-GPU (internal issue 835).
* Convert all files from use of // refBegin .. // refEnd comments to
delimit ref pages, to use of open blocks, and update style guide
accordingly (internal issue 839).
* Add valid usage for slink:VkWriteDescriptorSet when performing updates
to a ename:VK_STORAGE_IMAGE descriptor with layout
ename:VK_IMAGE_LAYOUT_GENERAL.
* Add a hack to the validity generator script to support an odd
interaction between flink:vkCmdFillBuffer and an extension (internal
issue 853).
* Remove redundant text describing slink:VkBufferCreateInfo::pname:usage,
which was already covered by implicit valid usage (internal issue 854).
* Update implicit validity generator script to properly handle the
pname:sType and pname:pNext members of "returnedonly" structures
(internal issue 874).
* Note that slink:VkApplicationInfo::pname:pApplicationName &
slink:VkApplicationInfo::pname:pEngineName are optional, and add missing
implicit valid usage statements for flink:vkDestroyInstance.
* Added missing valid usage for flink:vkCmdWriteTimestamp to require a
timestamp query pool.
* Simplify and/or split "`non-atomic`" valid usage statements.
New Extensions:
* `VK_AMD_gpu_shader_int16`
* `VK_EXT_blend_operation_advanced`
* `VK_EXT_sampler_filter_minmax`
* `VK_NV_framebuffer_mixed_samples`
-----------------------------------------------------
Note: the 1.0.52 spec wasn't published on github, so the 1.0.53 release
combines both change sets.
-----------------------------------------------------
Change log for June 13, 2017 Vulkan 1.0.52 spec update:
* Bump API patch number and header version number to 52 for this update.
Github Issues:
Internal Issues:
* Clarify behavior when non-coherent memory has
<<memory-device-unmap-does-not-flush, not been flushed before being
unmapped>> (internal issue 819).
* Fix description of code:WorkgroupSize builtin to note it decorates an
object, not a variable (internal issue 836).
* Fix asciidoc attributes so that trailing '{plus}' symbols in [eq] style
equations are rendered properly (internal issue 845).
* Add language to the "`Extension Handles, Objects, Enums, and Typedefs`"
section of the Procedures and Conventions document stating that any new
handle type requires a corresponding entry in the elink:VkObjectType
enumerated type (internal issue 856).
* Update style guide to use slink macro for Vulkan handle type names, and
define narrow conditions under which to use the *name and *text macros
instead of *link (internal issue 886).
* Add a dependency of the <<VK_KHX_device_group,VK_KHX_device_group>>
extension on VK_KHX_device_group_creation to +vk.xml+ and the extension
appendix.
* Change the copyright on Vulkan specification asciidoc *source* files to
CC-BY 4.0, and update the proprietary Khronos copyright applied to the
generated *output* formats (internal issue 327). This enables broader
re-use and modification of the Vulkan specification sources, while not
affecting the Reciprocal IP License between Vulkan Adopters and Working
Group Members.
New Extensions:
* `VK_NV_fill_rectangle`
* `VK_NV_fragment_coverage_to_color`
* Bump API patch number and header version number to 51 for this update.
Github Issues:
* Add Valid Usage statement to flink:vkCmdResolveImage to require that
source and destination image formats match (public issue 492).
* Specify that a code:char* parameter must: be a valid null-terminated
string in the <<fundamentals-implicit-validity, implicit valid usage>>
section (public issue 494).
* Removed unnecessary VU for slink:VkPhysicalDeviceFeatures which is
covered by ename:VK_ERROR_FEATURE_NOT_PRESENT already (public issue
496).
* Clarify valid usage of pname:pQueueFamilyIndices in
slink:VkBufferCreateInfo, slink:VkImageCreateInfo, and
slink:VkSwapchainCreateInfoKHR (public issue 501).
* Document that dependencies of enabled extensions must also be enabled in
the <<extended-functionality-extensions-dependencies, Extension
Dependencies>> section (public issue 507).
Internal Issues:
* Change slink:VkMappedMemoryRange valid usage to allow pname:offset +
pname:size == size of the allocation. Also, if ename:VK_WHOLE_SIZE is
used, require the end of the mapping to be aligned to a multiple of
pname:nonCoherentAtomSize (internal issue 611).
* Add issue to `VK_KHR_win32_surface` about reusing window objects from a
different graphics API or Vulkan ICD (internal issue 639).
* Require locations on user in/out in `GL_KHR_vulkan_glsl` (internal issue
783).
* Added version info to the json validation output, and updated the schema
to match (internal issue 838).
* Restructure enumerated type descriptions separately from the command or
structure they are used in, allowing better reference page generation
(internal issue 841).
* Re-sort extension appendices to be in alphabetical order within each
author ID section.
* Fix enum naming and clarify behavior for
`VK_NVX_device_generated_commands` extension.
New Extensions:
* Bump API patch number and header version number to 50 for this update.
Github Issues:
* Fix numerous minor issues with the VK_EXT_debug_report extension (public
issues 478, 483, 486, 489, 490).
Internal Issues:
* Update flink:vkAllocateDescriptorSets to specify conditions under which
to return ename:VK_ERROR_FRAGMENTED_POOL or
ename:VK_ERROR_OUT_OF_POOL_MEMORY instead of
out-of-host/out-of-device-memory, and improve the
<<fundamentals-errorcodes, description of those errors (internal issue
654).
* Add a NOTE documenting that flink:vkAcquireNextImageKHR can only signal
a single semaphore, and how to deal with that when multiple physical
devices in a logical device need to wait on it (internal issue 730).
* Improve description of pname:pNext chains of
slink:VkPhysicalDeviceImageFormatInfo2KHR and
slink:VkImageFormatProperties2KHR (internal issue 814).
* Clean up math markup issues in the <<textures, Image Operations>>
chapter (internal issue 818).
* Update validusage target to use more robust code for preprocessing, by
making direct use of Asciidoctor's preprocessor. Added uniqueItems check
to JSON vu schema and add clean_validusage target (internal issue 826).
* Update style guide to prohibit writing non-self-contained (on a single
bullet point) Valid Usage statements, and modify offending Valid Usage
statements in the Specification to match, to assist with automatic
extraction for the validation layers (internal issue 828).
* Add ename:VK_VALIDATION_CHECK_SHADERS_EXT to elink:VkValidationCheckEXT
of the `VK_EXT_validation_flags` extension, to selectively disable
shader validation.
* Remove duplicate valid usage statement for slink:VkImageMemoryBarrier.
* Modify reflow.py script to place VUID tag anchors standalone on a line
following their corresponding bullet point, and reflow the spec text
accordingly (this had been pending since the initial tag deployment).
New Extensions:
* `VK_AMD_texture_gather_bias_lod`
* Bump API patch number and header version number to 49 for this update.
Github Issues:
* Modify reference page extraction script to make internal links to spec
anchors refer to the core specification instead of being dangling links
(public issue 455).
* Fix GL_KHR_vulkan_glsl typo and add a nor-normative mapping to the newly
published StorageBuffer class (public issue 466).
* Both flink:vkEnumerateInstanceExtensionProperties and
flink:vkEnumerateDeviceExtensionProperties return
ename:VK_ERROR_LAYER_NOT_PRESENT, which covers the error case of an
application providing a layer name that wasn't returned by
ftext:vkEnumerate{Instance|Device}LayerProperties (public issue 487).
* The specification for flink:VkApplicationInfo::apiVersion says that the
driver must return ename:VK_ERROR_INCOMPATIBLE_DRIVER in the case that
pname:apiVersion specifies a non-supported version. That means that the
valid usage should not also state that, and so the VU statement is
removed. The VU had language about "`an effective substitute`" that
would have been lost, and so it was moved to the pname:apiVersion
description (public issue 488).
Internal Issues:
* Modify implicit validity generator script to assign asciidoc anchors to
all valid usage statements it generates, and reflow.py script to insert
Valid Usage ID (VUID) tags into the specification source files for
explicit valid usage statements. This has no semantic effects on the
specification, but will support the validation layer's detection of
valid usage violations and allow it to link into the corresponding part
of the specification (internal issue 583).
* Assign VUID tags to all explicit VU statements and document
the process and tag format in the style guide (internal issue 583).
* Clarify the rules of whether to structure new functionality as instance
extensions, device extensions, or both in the
<<extended-functionality-instance-extensions-and-devices, Instance
Extensions and Device Extensions>> section (internal issue 749).
* Require that SPIR-V run-time arrays are only used with the
code:BufferBlock decoration (internal issue 750).
* Fix implicit and explicit valid usage statements for
slink:VkWriteDescriptorSet::pname:dstSet (internal issue 767)
* Fix SPIR-V code sample for ename:VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER
in the <<descriptorsets-uniformtexelbuffer, Uniform Texel Buffer>>
section (internal issue 770).
* Clarify that disabling depth testing also disables depth writes in the
<<fragops-ds-state, Depth and Stencil Operations>> section (internal
issue 775).
* flink:VkDescriptorImageInfo::pname:imageLayout must match the actual
imageLayout at the time the image is accessed. This was in the spec
text, but needed an associated valid usage statement.
* Note that only 32-bit atomic operations are supported in the
<<spirvenv-module-validation, Validation Rules within a Module>>
section.
* Note that code:UniformConstant variables must not have initializers in
the <<spirvenv-module-validation, Validation Rules within a Module>>
section.
* Add a new elink:VkObjectType enumeration to the core API, promoted from
elink:VkDebugObjectTypeEXT, since it is used for much more than just the
debug_report extension.
New Extensions:
* `VK_KHR_get_surface_capabilities2`
* `VK_KHR_shared_presentable_image`
* Bump API patch number and header version number to 48 for this update.
Github Issues:
Internal Issues:
* Add missing VU statements for flink:vkUpdateDescriptorSets (internal
issue 333).
* Correct swapped ifdef/ifndef blocks for `VK_KHR_maintenance1` extension
(internal issue 776).
* Bump API patch number and header version number to 47 for this update.
Github Issues:
* Allow <<synchronization-pipeline-barriers-subpass-self-dependencies,
self-dependencies>> (also described for slink:VkSubpassDependency) to
have earlier stages depend on later stages if all stages are
framebuffer-space (public issue 125).
* Clarify when pipeline state structures are ignored in the
slink:VkGraphicsPipelineCreateInfo strucure, when the tessellation
structure must be valid, and remove 'if `NULL`' descriptions from the
valid usage statements (public issue 445).
* Remove the obsolete "validextensionstructs" attribute for
flink:VkPresentRegionsKHR. This caused a pname:pNext valid usage
statement to be generated which wasn't consistent with what is stated in
the spec (public issue 481).
Internal Issues:
* Clarify facingness of non-polygon fragments for slink:VkStencilOpState
and in the code:FrontFacing <<interfaces-builtin-variables,built-in
variable description>>. Define 'facingness' of a fragment as a distinct
term from facingness of a polygon (internal issue 662).
* Clarify that the texture compression features (e.g.
pname:textureCompressionBC) means that all formats of that type
(<<features-features-textureCompressionASTC_LDR,ASTC>>,
<<features-features-textureCompressionETC2,ETC2>>,
<<features-features-textureCompressionBC,BC>>) are supported, and that
support for individual formats may: queried separately (internal issue
663).
* Clarify in the valid usage for slink:VkBindImageMemoryInfoKHX that each
SFR rectangle must be a multiple of the sparse block size for each
aspect, e.g. in a depth/stencil image using separate depth/stencil
planes (internal issue 721).
* Re-remove KHX variants of KHR structure types after promotion (internal
issue 762).
* Bump API patch number and header version number to 46 for this update.
Github Issues:
* Add language to the <<fundamentals-validusage-enums, Valid Usage for
Enumerated Types>> section allowing values to be returned from Vulkan
that are not present in extensions explicitly enabled by the
application, similar to existing language for bit flags in the
<<fundamentals-validusage-flags, Valid Usage for Flags>> section (public
issue 442).
* *Important*: run `gem update --pre asciidoctor-pdf` before trying to
build this version of the spec - 1.5.0.alpha15 is required for this
change. Removes the monkey patch currently used to draw valid usage
blocks across multiple pages which had numerous issues. A fixed version
was incorporated into Asciidoctor-PDF for the latest release, so the
monkey patch or any variant thereof is no longer required (public issue
465).
Internal Issues:
* Add ename:VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_KHR_EXT
to `VK_EXT_debug_report` extension
* Fix ptext:pNext member of
slink:VkPhysicalDeviceDiscardRectanglePropertiesEXT to be a non-const
pointer. Properties structures return values, so the chain should be
non-const.
* Explicitly remove gl_NumSamples from the `GL_KHR_vulkan_glsl` extension,
against 1.0 (internal issue 612).
* Add Valid Usage statements requiring that each structure type valid in a
ptext:pNext chain must: not appear more than once in a chain (internal
issue 752).
* Use ename:VK_USE_PLATFORM_WIN32_KHX in the
`VK_KHX_external_memory_win32` extension, rather than etext:_KHR
(internal issue 754).
New Extensions:
* `VK_KHR_incremental_present`
* Bump API patch number and header version number to 45 for this update.
Github Issues:
* Defined the lifetime of the memory pointed to by
slink:VkDisplayPropertiesKHR::pname:displayName to be equal to that of
its associated display handle (public issue 460).
* Correct several cases where the sparse memory feature name
pname:residencyNonResidentStrict was written as
pname:sparseResidencyNonResidentStrict (public issue 475).
Internal Issues:
* Fix ptext:pNext member of slink:VkPhysicalDeviceGroupPropertiesKHX to be
a non-const pointer. Properties structures return values, so the chain
should be non-const.
* Clarify definition of memory aliasing to consistently use the terms
"linear" and "non-linear" when referring to resources, and define what
those terms mean.
* Modified XML schema and implicit validity scripts to generate language
for all ptext:pNext values in a ptext:pNext chain instead of just the
top level struct, and made `noautovalidity` functional for ptext:sType
and ptext:pNext (internal issue 535).
* Add more detail for BT2020 and scRGB color spaces in
`VK_EXT_swapchain_colorspace` extension (internal issue 632).
* Add naming rules for Extension Structure Names (structures added to the
ptext:pNext chain of a base structure) to the style guide (internal
issue 706).
* Define the glossary term "ptext:pNext chain", and use it consistently in
the spec (internal issue 744).
New Extensions:
* Bump API patch number and header version number to 44 for this update.
Github Issues:
* Fix description of <<features-extentperimagetype, Allowed Extent Values
Based On Image Type>> (public issue 290).
* Better specify VK_DEVICE_LOST behavior around flink:vkQueueSubmit,
flink:vkWaitForFences, and flink:vkGetFenceStatus (public issue 423).
* Clarify definition of flink:vkGetQueryPoolResults::pname:queryCount
(public issue 441).
* Simplify and clean up normative language. Remove shall and replace
recommend and variants with should wherever possible (public issue 448).
* Fix all dangling internal cross-references in the 1.0-extensions
specification, and add scripts/checkXrefs to find these in the future
(public issue 456).
* Reverse order of ChangeLog.txt entries so the most recent version is
documented first (public issue 463)
* Removes "become invalid" which clashes with invalid state for command
buffers. (public issue 467)
* Disallowed pending state in spec text for vkResetCommandBuffer, matching
valid usage (public issue 468)
* Removes sentence describing invalid state "like initial state". (public
issue 469)
* Disallows begin command buffer from resetting command buffers in the
"recording" state. (public issue 470)
* Removes mention of state from description of
VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT (public issue 471)
* Removed extra valid usage statement in VkSubmitInfo (public issue 472)
Internal Issues:
* Clarify description of the pname:imageLayout member of
sname:VkDescriptorImageInfo.
* Fix typos where etext:VK_VIEW_TYPE* was used instead of
etext:VK_IMAGE_VIEW_TYPE.
* Removed the <<VK_KHR_display>> and <<VK_KHR_display_swapchain>> example
code from the specification and noted it has been moved to the Vulkan
SDK cube demo (internal issue 179).
* Reorder VkExternalMemoryHandleTypeFlagBitsNV description (internal issue
480).
* Clarify than an implementation is
<<fundamentals-validusage-flags,permitted to return 'undefined' bit
flags>> in a bitfield (internal issue 640).
* Break Valid Usage statements describing unrelated parameters into
separate statements, and add a style guide entry to follow this approach
(internal issue 685).
* Move valid usage statement for slink:VkImageCreateInfo from spec body to
the explicit valid usage block (internal issue 693).
* Fix typos in the descriptions of slink:VkDisplaySurfaceCreateInfoKHR,
flink:vkCreateDisplayModeKHR, and
flink:vkGetDisplayPlaneSupportedDisplaysKHR in the <<display,Presenting
Directly to Display Devices>> section (internal issue 698, 704, 716).
* Clarified that mandatory depth/stencil formats are only a requirement
for 2D images (internal issue 719).
* Clarify that variables decorated with DeviceIndex/ViewIndex must be in
the Input storage class (internal issue 733).
* Work around generator script problem with removal of Unicode literals
from Python 3.0-3.2 using `future` package (internal issue 737).
* Remove nonexistent structure type enums from vk.xml (internal issue
738).
* Fix validextensionstructs attributes for structures in the pname:pNext
chain for VkPresentInfoKHR, fixing implicit valid usage statements for
those structures (internal issue 740).
New Extensions:
* Bump API patch number and header version number to 43 for this update.
Github Issues:
* Make clearer that color write mask is applied regardless of whether
blending is enabled, by referring to the
<<framebuffer-color-write-mask,Color Write Mask>> section (public issue
241).
* Fix public issue 414:
** Added two new command buffer states (invalid, pending), and an explicit
"command buffer lifecycle" section to explain them.
** Replaced "pending execution" with "in the pending state".
** Replaced a bunch of "this will invalidate the command buffer" language
with "this will move the command buffer to the invalid state", and added
validation language for what state those command buffers should be in.
** Added additional validation language about what state a command buffer
should be in for various commands that affect it.
** Added invalidation language to destroy commands in the lifetimes section
of fundamentals.
** Added command buffers to list of objects which must not be deleted
whilst a (primary) command buffer is in the recording or pending state.
* Update `GL_KHR_vulkan_glsl` extension to allow anonymous push constant
blocks (public issue 428).
Internal Issues:
* Document rules about extension interactions in the style guide (internal
issue 579).
* Require ename:VK_PRESENT_MODE_MAILBOX_KHR support in queries of surfaces
created with flink:vkCreateWaylandSurfaceKHR using the
VK_KHR_wayland_surface extension (internal issue 666).
* Remove Valid Usage constraints for flink:vkAllocateDescriptorSets when
the `VK_KHR_maintainance1` extension is present (internal issue 686).
* Remove undocumented KHX-variants of vkGetPhysicalDeviceProperties2KHR
and vkGetPhysicalDeviceImageFormatProperties2KHR from the
<<VK_KHX_external_memory_capabilities>> and
<<VK_KHX_external_semaphore_capabilities>> extensions.
New Extensions:
* `VK_EXT_hdr_metadata`
* `VK_GOOGLE_display_timing`
* Bump API patch number and header version number to 42 for this update
(the first anniversary edition).
Github Issues:
* Changed asciidoctor macros so cross-page links in the standalone
reference pages function properly (public issue 462).
Internal Issues:
* Clarified host visibility discussion for slink:VkMemoryType,
flink:vkInvalidateMappedMemoryRanges, elink:VkAccessFlagBits, and the
<<synchronization-framebuffer-regions,Framebuffer Region Dependencies>>
section, removing duplicated information and adding a central definition
in the access types section (internal issue 552).
* Change description of
slink:vkGetPhysicalDeviceSurfacePresentModesKHR::pname:pPresentModes to
return an array of values, not structures (internal issue 699).
New Extensions:
* Add a NOTE to the <<extensions,Layers & Extensions>> chapter describing
the experimental status of `KHX` extensions.
* Add new Khronos, Khronos Experimental, and vendor Vulkan extensions for
release at GDC:
** VK_KHR_descriptor_update_template
** VK_KHR_push_descriptor
** VK_KHX_device_group
** VK_KHX_device_group_creation
** VK_KHX_external_memory
** VK_KHX_external_memory_capabilities
** VK_KHX_external_memory_fd
** VK_KHX_external_memory_win32
** VK_KHX_external_semaphore
** VK_KHX_external_semaphore_capabilities
** VK_KHX_external_semaphore_fd
** VK_KHX_external_semaphore_win32
** VK_KHX_multiview
** VK_KHX_win32_keyed_mutex
** VK_EXT_discard_rectangles
** VK_MVK_ios_surface
** VK_MVK_macos_surface
** VK_NVX_multiview_per_view_attributes
** VK_NV_clip_space_w_scaling
** VK_NV_geometry_shader_passthrough
** VK_NV_sample_mask_override_coverage
** VK_NV_viewport_array2
** VK_NV_viewport_swizzle
* Add new GLSL vendor extensions to support new builtin variables:
** GL_EXT_device_group
** GL_EXT_multiview
* Bump API patch number and header version number to 41 for this update.
Github Issues:
* Made all uses of `NULL` vs. code:VK_NULL_HANDLE consistent (public issue
276).
* Clarify render pass compatibility in different usage scenarios (public
issues 303 and 304).
* Add valid usage statements to slink:VkFramebufferCreateInfo requiring
that the width, height, and number of layers of the framebuffer all be
nonzero (public issue 432).
* Allow `offset` and `align` in any GLSL version for the
`GL_KHR_vulkan_glsl` extension (public issue 435).
* Specify lifetime of string objects passed to the
tlink:PFN_vkDebugReportCallbackEXT user callback in the
+VK_EXT_debug_report+ extension (public issue 446).
* Fix inter-page links in multi-file reference pages (public issue 454).
Internal Issues:
* Update valid usage language for slink:VkImageCreateInfo to disallow
creating images that have ename:VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
set without other attachment usage bits
(ename:VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT,
ename:VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, or
ename:VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) (internal issue 540).
* Disable `VK_EXT_swapchain_colorspace` extension until internal issues
640 and 661 are mutually resolved.
* Allow alternative mipmap level selection when [eq]#lambda == 0.5# during
texture <<textures-image-level-selection,Image Level(s) Selection>>
(internal issue 680).
Other Issues:
* Add a clarification to the style guide that the extension revision
number is treated as a patch number, so that changes to published
extensions should only include bug fixes and spec clarifications.
Jon Leech
MrVallentin
Petr Kraus