1) Make explicit there is a <=> relationship between `DEVICE_LOCAL` heap
and `DEVICE_LOCAL` memory type
2) Make >4GB runtime error report mandatory. Otherwise it basically says
"do not pass >= 4GB, because possible undefined behavior".
3) Removed `VUID-vkAllocateMemory-device-00636`. Behavior is
deterministic returning `VK_ERROR_TOO_MANY_OBJECTS`
4) Moved `allocationSize` VU (depends on non-local state).
5) Changed `allocationSize`. Not sure what the original means, so
improvized a new one saying alloc size must be <= the whole size of the
heap.
6) Added VU restricting `memoryTypeIndex` to only the memory types of
the device.
1) Random grammar and formatting
2) Make example in first paragraph more
straightforward with elementary
Vulkan primitives (the original also
seemed factually wrong in places;
e.g. does UBO really have to be in
"on-device" memory?)
3) Removed unnecessary brandishing of obscure math
describing the memory
type list order. Tried something equally formal,
but more readable.
4) Made a note into a Note
5) Updated example.
Function names seem to be lower-case in the spec.
Hopefully made it bit
more readable. Turned the acompanying note into
the example content and
inline comments.
6) Removed redundant `VkDeviceMemory` intro
7) Break
out specifying language out of a Note
8) More straightforward description of `memoryTypeIndex`
* Bump API patch number and header version number to 64 for this update.
Github Issues:
* Add chapter name to the PDF page footer (public pull request 458).
* Fix several mistaken references to the nonexistent etext:VK_DEVICE_LOST
status to etext:VK_ERROR_DEVICE_LOST (public pull request 502).
* Fix description of the tlink:PFN_vkDebugReportCallbackEXT debug report
callback function pointer to match the validation layer behavior (public
issue 534).
* Document experimental KHX extensions and alternate vendor author IDs
also ending in X in more detail in the <<extensions, Layers &
Extensions>> appendix, the extensions section of the style guide, and
the registry schema description document (public issues 536, 580).
* Fix references to ptext:pDepthStencil to properly refer to
pname:pDepthStencilState or pname:pRasterizationState as appropriate in
the slink:VkGraphicsPipelineCreateInfo description (public issue 542).
* Fix wrong parameter name in slink:VkPipelineMultisampleStateCreateInfo
valid usage (public pull request 571).
Internal Issues:
* Update the style guide to describe how to write LaTeX math expressions
in table cells (internal issue 908).
* Define how framebuffer-local dependencies work between subpasses with
the same or different numbers of samples, in the
slink:VkSubpassDescription and <<synchronization-framebuffer-regions,
Framebuffer Region Dependencies>> sections. This clarifies which samples
in an input attachment you are allowed to access after a
framebuffer-local dependency (internal issue 915).
* Specify which storage classes can have an initializer in the
<<spirvenv-module-validation, Validation Rules within a Module>> section
(internal issue 1023).
* Use "LOD" consistently for "level-of-detail", to eliminate spelling
inconsistencies. The term is already standardized in the Glossary
(internal issue 1027).
Other Issues:
* Fix false positives in Makefile dependencies when rules fail, by
deleting partially-made targets.
New Extensions:
* `VK_AMD_shader_info`
- fix `pretransform` and `compositeAlpha`; they are values not bitmasks
- update `imageFormat`, `imageColorSpace`, `imageUsage` and
`oldSwapchain` to be specific to behavior of this command
- fix broken unintended code block
- move `VK_TRUE` clipping text to correct bullet point
- random tweaks...
- fix bad description (VU like) block + some tweaks
- remove redundant VUs (redundant due to required equality to
`VkPipelineViewportStateCreateInfo::viewportCount`)
- move `viewportCount` equality VU to
`VkPipelineViewportStateCreateInfo` where it belongs
- make a dynamic state related VU in `VkGraphicsPipelineCreateInfo`
1) State more explicitly in implicit VUs if a "valid" pointer is required
2) For some time Implicit validity is quite explicit in implicit VU
sections. Update pointer implicit validity chapter section as such.
3) Sometimes pointer parameter can be ignored. Update implicit pointer
validity section as such.
4) Changeing to more forceful language, to clarify memory behind
pointers need synchronizing too
* 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`
1) Fix `pSampleMask `s `altlen` to have C99 semantics equivalent to len
2) Fix `registry.rnc` to also have altlen for `param`s
3) Document `altlen` in `registry.rnc` comments
4) Clarify `altlen` in schema doc that beside C syntax it also follows C
semantics
5) Clarify `altlen` in schema doc in case there ever is `latexmath` in
comma separated `len`
- Make implicit validity for optional `void*` mean "nothing" in the
script
- Make `optional` mean non-NULL for `void*` (not implemented)
- Uses of `void*` that point to something should have `noautovalidity`
(adding it)
- Add missing explicit VUs of `void*` parameters
(`vkCmdPushDescriptorSetWithTemplateKHR` and
`vkUpdateDescriptorSetWithTemplateKHR`)
- Also indirectly fixes `vkMapMemory`, `VkAllocationCallbacks`,
`VkDebugReportCallbackCreateInfoEXT`, and Apple and NN surface create
- Remove ugly text hack from script
Previously
(`vkGetDeviceGroupSurfacePresentModesKHX::pModes` and
`vkGetDeviceGroupPeerMemoryFeaturesKHX::pPeerMemoryFeatures`)
required output flags pointer to be valid + non-0
* 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 60 for this update.
Github Issues:
* Document that <<queries-timestamps, Timestamp Queries>> can only be
meaningfully compared when they are written from the same queue (public
issue 216).
* Document that the `<extension>` tag `type` attribute is required for
non-disabled extensions (derived from, but does not close public issue
354).
* Clean up registry schema length attribute descriptions to be consistent
and correct (public issue 555).
Internal Issues:
* Replace as much of the hand-written extension appendix metadata as
possible with asciidoc includes generated from corresponding attributes
of +vk.xml+, and enhance the style guide to match. This avoids
inconsistencies between +vk.xml+ and the appendices, and produces a more
uniform style (internal issue 137).
* Remove the generated extDependency.{py,sh} files from the tree and
create them dynamically on demand instead, reducing merge conflicts
(internal issue 713).
* Add a prototype tool for generating in-place difference markup for
sections guarded by asciidoc conditionals, and new syntax for open
blocks to support it (internal issue 833).
* Remove unnecessary restriction of etext:*SYNC_FD_BIT_KHR external handle
types to the same physical device in the
slink:VkPhysicalDeviceIDPropertiesKHR,
flink:VkImportMemoryWin32HandleInfoKHR,
slink:VkImportFenceWin32HandleInfoKHR, slink:VkImportFenceFdInfoKHR,
slink:VkImportSemaphoreWin32HandleInfoKHR,
slink:VkImportSemaphoreFdInfoKHR
<<external-memory-handle-types-compatibility, External memory handle
types compatibility>>, <<external-semaphore-handle-types-compatibility,
External semaphore handle types compatibility>>, and
<<external-fence-handle-types-compatibility, External fence handle types
compatibility>> sections (internal issue 956).
Other Issues:
* Remove dependency of +VK_KHX_device_group+ on +VK_KHR_swapchain+ (there
is an interaction, but not a strict dependency), and add a new
`extension` attribute to the `<require` XML tag to allow classifying a
subset of interfaces of an extension as requiring another extension.
Update the registry schema and documentation accordingly.
New Extensions:
* `VK_AMD_shader_fragment_mask` (and related `GL_AMD_shader_fragment_mask`
GLSL extension)
* `VK_EXT_sample_locations`
* `VK_EXT_validation_cache`
* 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 56 for this update.
Github Issues:
* Add valid usage statements for commands introduced by
`VK_EXT_debug_report` and `VK_EXT_debug_marker` extensions, regarding
the valid pname:object and pname:objectType values (public issue 495).
* Modify `GL_KHR_vulkan_glsl` specification to document that uniform and
buffer block arrays each take only a single binding (public issue 514).
* Add `KHX` author tag to +vk.xml+ (public issue 526).
Internal Issues:
* Document use of code: macro for non-Vulkan APIs in the style guide
(internal issue 863).
* Document that reference page open block delimiters must not contain
asciidoc section markup in the style guide (internal issue 898).
* Fix <<spirvenv,SPIR-V appendix>> to say
code:VariablePointersStorageBuffer instead of
code:VariablePointersUniformBufferBlock (internal issue 928).
Other Commits:
* Add missing extension structures to dependency attributes in +vk.xml+.
New Extenions:
* `VK_EXT_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).
Petr Kraus
Jon Leech
Jon Leech
tomaka
Markus Tavenrath
Jacob Lifshay
Dennis Hamester