Change log for September 16, 2016 Vulkan 1.0.27 spec update:

* Bump API patch number and header version number to 27 for this update. Github Issues: * Weaken flink:vkGetPipelineCacheData invariance conditions; previous conditions were stronger than agreed and can't be guaranteed (public issue 280). * Add link to "Vulkan Loader Specification and Architecture Overview" document to Normative References section (public issue 359). Internal Issues: * Be more clear in the <<interfaces-resources-layout-std140, uniform buffer layout>> section that block offsets can be out of order (internal issue 396). * Document that extension authors should add support for their extensions to the validation layers (internal issue 398). * Clarify that the valid range of depth clear values should be limited to the 0..1 range and that copies to depth aspect must also be in this range (internal issue 412). * Specify ``a'' vs. ``an'' use in the style guide (internal issue 432). * Increase the maximum pname:nonCoherentAtomSize value in the <<features-limits-required,Required Limits>> section from 128 to 256 (internal issue 435). * Fix vk_platform.h for compiler errors on some Android platforms (internal issue 441). * Clarify that slink:VkPhysicalDeviceFeatures::pname:pEnabledFeatures == `NULL` disables all features, including the "required" feature pname:robustBufferAccess (internal issue 479). Other Issues: * Expand style guide and make it more self-consistent. * Use ISO 8601 date format everywhere. * Emphasise the correct way of using slink:VkSurfaceCapabilitiesKHR::pname:maxImageCount. * Added +VK_EXT_validation_flags+ extension for validation flag mechanism. * Fix an <<credits,author credit>> to include their current employer.
MuAlphaOmegaEpsilon · Sep 17, 2016 · ef053e7 · ef053e7
1 parent e29c248
commit ef053e7
Show file tree

Hide file tree

Showing 114 changed files with 2,780 additions and 1,333 deletions.
diff --git a/.gitignore b/.gitignore
@@ -34,13 +34,25 @@
 __pycache__
 .pyc
 
-# Spec build temporary files and outputs
+# Spec build generated, temporary, and output files
+
+# Files generated from vk.xml
+doc/specs/vulkan/api
+doc/specs/vulkan/hostsynctable
+doc/specs/vulkan/validity
+
+# Files generated by extraction from spec source
+doc/specs/vulkan/man/PFN*.txt
+doc/specs/vulkan/man/[Vv][Kk]*.txt
+
+# Files otherwise generated by the Makefile
+doc/specs/vulkan/specversion.txt
+
+# Output files and directories
 out/1.0*
-out/genRef
 out/misc
-doc/specs/vulkan/specversion.txt
 
-# Header build temporary files
+# Files generated by the vulkan.h build
 src/spec/diag.txt
 
 # OS X folder attributes

diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -1297,3 +1297,46 @@ Other Issues:
     elink:VkExternalMemoryFeatureFlagBitsNV (KhronosGroup/Vulkan-Hpp issue
     25)
   * Cleanup reference page builds so only core pages are built for releases.
+
+-----------------------------------------------------
+
+Change log for September 16, 2016 Vulkan 1.0.27 spec update:
+
+  * Bump API patch number and header version number to 27 for this update.
+
+Github Issues:
+
+  * Weaken flink:vkGetPipelineCacheData invariance conditions; previous
+    conditions were stronger than agreed and can't be guaranteed (public
+    issue 280).
+  * Add link to "Vulkan Loader Specification and Architecture Overview"
+    document to Normative References section (public issue 359).
+
+Internal Issues:
+
+  * Be more clear in the <<interfaces-resources-layout-std140, uniform
+    buffer layout>> section that block offsets can be out of order
+    (internal issue 396).
+  * Document that extension authors should add support for their extensions
+    to the validation layers (internal issue 398).
+  * Clarify that the valid range of depth clear values should be limited
+    to the 0..1 range and that copies to depth aspect must also be in this
+    range (internal issue 412).
+  * Specify ``a'' vs. ``an'' use in the style guide (internal issue 432).
+  * Increase the maximum pname:nonCoherentAtomSize value in the
+    <<features-limits-required,Required Limits>> section from 128 to 256
+    (internal issue 435).
+  * Fix vk_platform.h for compiler errors on some Android platforms
+    (internal issue 441).
+  * Clarify that slink:VkPhysicalDeviceFeatures::pname:pEnabledFeatures ==
+    `NULL` disables all features, including the "required" feature
+    pname:robustBufferAccess (internal issue 479).
+
+Other Issues:
+
+  * Expand style guide and make it more self-consistent.
+  * Use ISO 8601 date format everywhere.
+  * Emphasise the correct way of using
+    slink:VkSurfaceCapabilitiesKHR::pname:maxImageCount.
+  * Added +VK_EXT_validation_flags+ extension for validation flag mechanism.
+  * Fix an <<credits,author credit>> to include their current employer.
diff --git a/doc/specs/misc/GL_KHR_vulkan_glsl.txt b/doc/specs/misc/GL_KHR_vulkan_glsl.txt
@@ -33,8 +33,8 @@ Status
 
 Version
 
-    Last Modified Date: 1-Aug-2016
-    Revision: 32
+    Last Modified Date: 30-Aug-2016
+    Revision: 33
 
 Number
 
@@ -898,6 +898,27 @@ Changes to Chapter 4 of the OpenGL Shading Language Specification
       "However, when push_constant is declared, the default layout of the
       buffer will be std430. There is no method to globally set this default."
 
+    Change from:
+
+      "It is a compile-time error to specify an offset that is smaller than the
+      offset of the previous member in the block or that lies within the
+      previous member of the block."
+
+    To instead say:
+
+      "It is a compile-time error to have any offset, explicit or assigned,
+      that lies within another member of the block."
+
+    Change from:
+
+      "If offset was declared, start with that offset, otherwise start with the
+      next available offset."
+
+    To instead say:
+
+      "If offset was declared, start with that offset, otherwise start with the
+      offset immediately following the preceding member (in declaration order)."
+
     Remove the following preamble from section 4.7, which exists for desktop
     versions, but not ES versions.  Removal:
 
@@ -1308,6 +1329,7 @@ Revision History
 
     Rev.    Date         Author    Changes
     ----  -----------    -------  --------------------------------------------
+    33    30-Aug-2016    JohnK    Allow out-of-order offsets in a block
     32     1-Aug-2016    JohnK    Remove atomic_uint and more fully subroutine
     31    20-Jul-2016    JohnK    Have desktop versions respect mediump/lowp
     30    12-Apr-2016    JohnK    Restrict spec-const operations to non-float

diff --git a/doc/specs/vulkan/Makefile b/doc/specs/vulkan/Makefile
@@ -1,5 +1,16 @@
 # Copyright (c) 2014-2016 The Khronos Group Inc.
-# Copyright notice at https://www.khronos.org/registry/speccopyright.html
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 # Vulkan Specification makefile
 #
@@ -149,7 +160,7 @@ GENDEPENDS = api/timeMarker validity/timeMarker hostsynctable/timeMarker
 COMMONDOCS = $(CHAPTERS) $(GENINCLUDE) $(GENDEPENDS)
 # A generated included file containing the spec version, date, and git commit
 SPECVERSION = specversion.txt
-SPECREVISION = 1.0.26
+SPECREVISION = 1.0.27
 SPECREMARK =
 
 # Spec targets
@@ -234,6 +245,8 @@ $(SPECVERSION): $(GITHEAD)
 	    "commit:" `git log -1 --format="%H"` >> $@
 endif
 
+# Vulkan Documentation and Extensions, a.k.a. "Style Guide"
+
 STYLESRC = styleguide.txt
 STYLEFILES = $(wildcard style/[A-Za-z]*.txt)
 
@@ -245,6 +258,16 @@ $(OUTDIR)/styleguide.html: $(CONFIG) $(SPECVERSION) $(STYLESRC) $(STYLEFILES) $(
 	    -o $@ -a svgpdf=$(SVGTYPEHTML) \
 	    $(STYLESRC)
 
+# Reflow text in spec sources
+REFLOW = reflow.py
+REFLOWOPTS = -overwrite
+
+reflow:
+	$(QUIET) echo "Warning: please verify the spec outputs build without changes!"
+	$(PYTHON) $(REFLOW) $(REFLOWOPTS) $(TOPDOC) $(CHAPTERS) $(STYLESRC) $(STYLEFILES)
+
+# Clean generated and output files
+
 clean: clean_html clean_pdf clean_man clean_checks clean_generated clean_dirt
 
 clean_html:

diff --git a/doc/specs/vulkan/README.adoc b/doc/specs/vulkan/README.adoc
@@ -373,13 +373,13 @@ Optional Cygwin packages (current version):
 [[history]]
 == Revision History
 
-* 2016/08/25 - Update for the single-branch model.
-* 2016/07/10 - Update for current state of spec and ref page generation.
-* 2015/11/11 - Add new can: etc. macros and DBLATEXPREFIX variable.
-* 2015/09/21 - Convert document to asciidoc and rename to README.md
+* 2016-08-25 - Update for the single-branch model.
+* 2016-07-10 - Update for current state of spec and ref page generation.
+* 2015-11-11 - Add new can: etc. macros and DBLATEXPREFIX variable.
+* 2015-09-21 - Convert document to asciidoc and rename to README.md
   in the hope the gitlab browser will render it in some fashion.
-* 2015/09/21 - Add descriptions of LaTeX+MathJax math support for all
+* 2015-09-21 - Add descriptions of LaTeX+MathJax math support for all
   output formats.
-* 2015/09/02 - Added Cygwin package info.
-* 2015/09/02 - Initial version documenting macros, required toolchain
+* 2015-09-02 - Added Cygwin package info.
+* 2015-09-02 - Initial version documenting macros, required toolchain
   components and versions, etc.
diff --git a/doc/specs/vulkan/appendices/VK_AMD_draw_indirect_count.txt b/doc/specs/vulkan/appendices/VK_AMD_draw_indirect_count.txt
@@ -1,14 +1,20 @@
+[[VK_AMD_draw_indirect_count]]
 == VK_AMD_draw_indirect_count
 
-*Name String*:: VK_AMD_draw_indirect_count
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 34
-*Last Modified Date*:: 8/23/2016
-*Revision*:: 1
+*Name String*::
+    VK_AMD_draw_indirect_count
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    34
+*Last Modified Date*::
+    2016-08-23
+*Revision*::
+    1
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
-    - This extension is written against version {apiversion} of the Vulkan API.
+    - This extension is written against version 1.0 of the Vulkan API.
 *Contributors*::
     - Matthaeus G. Chajdas, AMD
     - Derrick Owens, AMD

diff --git a/doc/specs/vulkan/appendices/VK_AMD_gcn_shader.txt b/doc/specs/vulkan/appendices/VK_AMD_gcn_shader.txt
@@ -1,12 +1,18 @@
+[[VK_AMD_gcn_shader]]
 == VK_AMD_gcn_shader
 
-*Name String*:: VK_AMD_gcn_shader
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 26
-*Last Modified Date*:: 5/30/2016
-*Revision*:: 1
+*Name String*::
+    VK_AMD_gcn_shader
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    26
+*Last Modified Date*::
+    2016-05-30
+*Revision*::
+    1
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
     - This extension is written against version 1.0.15 of the Vulkan API.
 *Contributors*::

diff --git a/doc/specs/vulkan/appendices/VK_AMD_negative_viewport_height.txt b/doc/specs/vulkan/appendices/VK_AMD_negative_viewport_height.txt
@@ -0,0 +1,28 @@
+[[VK_AMD_negative_viewport_height]]
+== VK_AMD_negative_viewport_height
+
+*Name String*::
+    VK_AMD_negative_viewport_height
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    36
+*Last Modified Date*::
+    2016-09-02
+*Revision*::
+    1
+*IP Status*::
+    No known IP claims.
+*Dependencies*::
+    - This extension is written against version 1.0 of the Vulkan API.
+*Contributors*::
+    - Matthaeus G. Chajdas, AMD
+    - Graham Sellers, AMD
+    - Baldur Karlsson
+*Contacts*::
+    - Matthaeus G. Chajdas, AMD (matthaeus.chajdas@amd.com)
+
+This extension allows an application to specify a negative viewport height. The result is that the viewport transformation will flip along the y-axis.
+
+ * Revision 1, 2016-09-02 (Matthaeus Chajdas)
+   - Initial draft
diff --git a/doc/specs/vulkan/appendices/VK_AMD_rasterization_order.txt b/doc/specs/vulkan/appendices/VK_AMD_rasterization_order.txt
@@ -1,12 +1,18 @@
+[[VK_AMD_rasterization_order]]
 == VK_AMD_rasterization_order
 
-*Name String*:: VK_AMD_rasterization_order
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 19
-*Last Modified Date*:: 04/25/2016
-*Revision*:: 1
+*Name String*::
+    VK_AMD_rasterization_order
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    19
+*Last Modified Date*::
+    2016-04-25
+*Revision*::
+    1
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
   - This extension is written against version 1.0.11 of the Vulkan API.
 *Contributors*::
@@ -96,7 +102,7 @@ None
     repeatability and other invariance rules of the API?
 
     RESOLVED: Yes, in the sense that it extends the list of exceptions when
-    the repeatability requirement doesn't apply.
+    the repeatability requirement does not apply.
 
 === Examples
 

diff --git a/doc/specs/vulkan/appendices/VK_AMD_shader_explicit_vertex_parameter.txt b/doc/specs/vulkan/appendices/VK_AMD_shader_explicit_vertex_parameter.txt
@@ -1,12 +1,18 @@
+[[VK_AMD_shader_explicit_vertex_parameter]]
 == VK_AMD_shader_explicit_vertex_parameter
 
-*Name String*:: VK_AMD_shader_explicit_vertex_parameter
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 22
-*Last Modified Date*:: 5/10/2016
-*Revision*:: 1
+*Name String*::
+    VK_AMD_shader_explicit_vertex_parameter
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    22
+*Last Modified Date*::
+    2016-05-10
+*Revision*::
+    1
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
     - This extension is written against version 1.0.11 of the Vulkan API.
 *Contributors*::

diff --git a/doc/specs/vulkan/appendices/VK_AMD_shader_trinary_minmax.txt b/doc/specs/vulkan/appendices/VK_AMD_shader_trinary_minmax.txt
@@ -1,12 +1,18 @@
+[[VK_AMD_shader_trinary_minmax]]
 == VK_AMD_shader_trinary_minmax
 
-*Name String*:: VK_AMD_shader_trinary_minmax
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 21
-*Last Modified Date*:: 5/10/2016
-*Revision*:: 1
+*Name String*::
+    VK_AMD_shader_trinary_minmax
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    21
+*Last Modified Date*::
+    2016-05-10
+*Revision*::
+    1
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
     - This extension is written against version 1.0.11 of the Vulkan API.
 *Contributors*::

diff --git a/doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt b/doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt
@@ -1,12 +1,18 @@
+[[VK_EXT_debug_marker]]
 == VK_EXT_debug_marker
 
-*Name String*:: VK_EXT_debug_marker
-*Extension Type*:: Device extension
-*Registered Extension Number*:: 23
-*Last Modified Date*:: 04/23/2016
-*Revision*:: 3
+*Name String*::
+    VK_EXT_debug_marker
+*Extension Type*::
+    Device extension
+*Registered Extension Number*::
+    23
+*Last Modified Date*::
+    2016-04-23
+*Revision*::
+    3
 *IP Status*::
-No known IP claims.
+    No known IP claims.
 *Dependencies*::
   - This extension is written against version 1.0.11 of the Vulkan API.
 *Contributors*::