Skip to content
Permalink
Browse files

Change log for February 10, 2017 Vulkan 1.0.40 spec update:

  * Bump API patch number and header version number to 40 for this update.
  * There is a major build change in this release. We are now using the
    Ruby-based ``asciidoctor'' implementation, rather than the Python-based
    ``asciidoc'' implementation, to process the specification. While the
    actual specification markup changes were minimal, this requires a new
    set of build tools and a very different installation process, especially
    because we now use an experimental direct-to-PDF backend for Asciidoctor
    instead of Docbook->dblatex->PDF. It is no longer possible to build the
    Specification using asciidoc. See doc/specs/vulkan/README.adoc
    for some guidance on installing the new toolchain components.
  * There are some minor rendering issues in the PDF output due to teething
    problems with the asciidoctor toolchain, especially with mathematical
    equations. We are aware of these and working on them.

Github Issues:

  * Updated sample code for the <<sparsememory-examples-basic,sparse
    resource binding example>> (public issue 97).
  * Modify line and point clipping behavior in the
    <<vertexpostproc-clipping, Primitive Clipping>> section to allow for
    pop-free behavior. The ability to check for which behavior is
    implemented may be added a future feature or extension (public issue
    113).
  * Unify the discussions of implicit ordering throughout the spec, in
    particular in the new sections <<drawing-primitive-order, Primitive
    Order>>, <<primrast-order, Rasterization Order>>, and
    <<synchronization-implicit, Implicit Synchronization Guarantees>>; the
    discussion of <<synchronization-submission-order, submission order>>;
    and references elsewhere to these sections (public issue 133).
  * Clarify \<\<descriptorsets-compatibility,Pipeline Layout Compatibility>>
    language and introduce the term ``identically defined'' (public issue
    164).
  * Add a dependency to the +VK_EXT_debug_marker+ extension that's needed to
    reuse the object type enum from +VK_EXT_debug_report+, and moves the
    definition of that enum into +VK_EXT_debug_report+ where it should be
    (public issue 409).
  * Remove redundant valid usage statement from slink:VkImageBlit (public
    issue 421).
  * Update GL_KHR_vulkan_glsl to allow the ternary operator to result in a
    specialization constant (public issue 424).
  * Fix valid usage for flink:VkPipelineShaderStageCreateInfo (public issue
    426).
  * Correct typo in New Objects list for <<VK_EXT_debug_report>> (public
    issue 447).

Internal Issues:

  * Moved to asciidoctor for spec builds (internal issue 121).
  * Update style guide to describe where to put new extensions-specific
    asciidoc files, and what to name them (internal issue 626).
  * Add src/spec/indexExt.py to autogenerate registry index entries linking
    into the 1.0-extensions specification, instead of maintaining the index
    manually. (internal issue 642).
  * Autogenerate extension dependencies and lists of all extensions and all
    KHR extensions from the "supported" attributes in +vk.xml+. Execute
    +make config/extDependency.sh+ from +doc/specs/vulkan+ when a supported
    extension is added to vk.xml, to regenerate the dependency script. The
    consequence is that specifying a single extension to the +makeExt+
    script will automatically enable all extensions it depends on as well,
    and that the +makeAllExts+ and +makeKHR+ scripts do not need to be
    updated when a new extension is supported (internal issue 648).
  * Put extension appendices all at the same asciidoc section level, so KHR
    WSI extensions show up in the HTML index (internal issue 648).

Other Issues:

  * Imbed images in the generated HTML specs instead of loading them from
    the images/ directory.
  * Fix missing EXT in extension name
    (ename:VK_EXT_SWAPCHAIN_COLOR_SPACE_EXTENSION_NAME).
  * Add new +VK_EXT_SMPTE_2086_metadata+ extension.
  * In the <<platformCreateSurface_xlib,Xlib Surface>> section of the
    +VK_KHR_xlib_surface+ specification, add language warning users that
    they always need to call code:XinitThreads.
  * Use the term "presentable image" (rather than "swapchain image")
    consistently in +VK_KHR_swapchain+ and related extensions, and add a
    glossary term defining it.
  * Relocate the valid usage for samples of
    flink:vkGetPhysicalDeviceSparseImageFormatProperties2KHR::pname:pFormatInfo
    to be below the flink:VkPhysicalDeviceSparseImageFormatInfo2KHR
    structure.
  • Loading branch information...
oddhack committed Feb 11, 2017
1 parent ca4abe0 commit 82e0f83d43f36c8c98c2aaed8da152480acb477b
Showing with 3,207 additions and 5,180 deletions.
  1. +8 −0 .gitattributes
  2. +86 −0 ChangeLog.txt
  3. +0 −2 README.md
  4. +5 −2 doc/specs/misc/GL_KHR_vulkan_glsl.txt
  5. +91 −152 doc/specs/vulkan/Makefile
  6. +538 −288 doc/specs/vulkan/README.adoc
  7. +0 −1,373 doc/specs/vulkan/README.html
  8. +0 −3 doc/specs/vulkan/README.md
  9. +72 −0 doc/specs/vulkan/appendices/VK_EXT_SMPTE2086_metadata.txt
  10. +14 −7 doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt
  11. +8 −4 doc/specs/vulkan/appendices/VK_EXT_debug_report.txt
  12. +2 −2 doc/specs/vulkan/appendices/VK_EXT_shader_subgroup_vote.txt
  13. +13 −13 doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt
  14. +1 −1 doc/specs/vulkan/appendices/VK_IMG_filter_cubic.txt
  15. 0 ...ulkan/appendices/{VK_KHR_android_surface/vk_khr_android_surface.txt → VK_KHR_android_surface.txt}
  16. +2 −1 doc/specs/vulkan/appendices/{VK_KHR_display/vk_khr_display.txt → VK_KHR_display.txt}
  17. +1 −1 ...appendices/{VK_KHR_display_swapchain/vk_khr_display_swapchain.txt → VK_KHR_display_swapchain.txt}
  18. +1 −1 doc/specs/vulkan/appendices/VK_KHR_get_physical_device_properties2.txt
  19. 0 doc/specs/vulkan/appendices/{VK_KHR_mir_surface/vk_khr_mir_surface.txt → VK_KHR_mir_surface.txt}
  20. +2 −2 doc/specs/vulkan/appendices/VK_KHR_sampler_mirror_clamp_to_edge.txt
  21. 0 doc/specs/vulkan/appendices/{VK_KHR_surface/vk_khr_surface.txt → VK_KHR_surface.txt}
  22. +0 −63 doc/specs/vulkan/appendices/VK_KHR_surface/wsi.txt
  23. 0 doc/specs/vulkan/appendices/{VK_KHR_swapchain/vk_khr_swapchain.txt → VK_KHR_swapchain.txt}
  24. 0 ...ulkan/appendices/{VK_KHR_wayland_surface/vk_khr_wayland_surface.txt → VK_KHR_wayland_surface.txt}
  25. 0 ...pecs/vulkan/appendices/{VK_KHR_win32_surface/vk_khr_win32_surface.txt → VK_KHR_win32_surface.txt}
  26. 0 doc/specs/vulkan/appendices/{VK_KHR_xcb_surface/vk_khr_xcb_surface.txt → VK_KHR_xcb_surface.txt}
  27. 0 doc/specs/vulkan/appendices/{VK_KHR_xlib_surface/vk_khr_xlib_surface.txt → VK_KHR_xlib_surface.txt}
  28. 0 doc/specs/vulkan/appendices/{VK_NN_vi_surface/vk_nn_vi_surface.txt → VK_NN_vi_surface.txt}
  29. +1 −1 doc/specs/vulkan/appendices/VK_NV_dedicated_allocation.txt
  30. +1 −1 doc/specs/vulkan/appendices/VK_NV_external_memory.txt
  31. +1 −1 doc/specs/vulkan/appendices/VK_NV_external_memory_win32.txt
  32. +1 −1 doc/specs/vulkan/appendices/VK_NV_glsl_shader.txt
  33. +1 −1 doc/specs/vulkan/appendices/VK_NV_win32_keyed_mutex.txt
  34. +7 −7 doc/specs/vulkan/appendices/compressedtex.txt
  35. +58 −8 doc/specs/vulkan/appendices/extensions.txt
  36. +16 −2 doc/specs/vulkan/appendices/glossary.txt
  37. +3 −3 doc/specs/vulkan/appendices/invariance.txt
  38. +4 −4 doc/specs/vulkan/appendices/spirvenv.txt
  39. +64 −0 doc/specs/vulkan/chapters/VK_EXT_SMPTE2086_metadata.txt
  40. +0 −57 doc/specs/vulkan/chapters/VK_EXT_debug_marker.txt
  41. +61 −1 doc/specs/vulkan/chapters/VK_EXT_debug_report.txt
  42. +4 −4 doc/specs/vulkan/chapters/VK_IMG_filter_cubic/filter_cubic_texel_filtering.txt
  43. +4 −4 doc/specs/vulkan/chapters/VK_IMG_filter_cubic/filter_cubic_texel_selection.txt
  44. +2 −0 doc/specs/vulkan/chapters/VK_IMG_filter_cubic/supported_formats.txt
  45. +1 −1 doc/specs/vulkan/chapters/VK_KHR_android_surface/platformCreateSurface_android.txt
  46. +1 −1 doc/specs/vulkan/chapters/VK_KHR_mir_surface/platformCreateSurface_mir.txt
  47. +6 −7 doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt
  48. +12 −8 doc/specs/vulkan/chapters/VK_KHR_swapchain/wsi.txt
  49. +4 −3 doc/specs/vulkan/chapters/VK_KHR_xlib_surface/platformCreateSurface_xlib.txt
  50. +1 −1 doc/specs/vulkan/chapters/VK_NV_external_memory_win32/handle_permissions.txt
  51. +2 −2 doc/specs/vulkan/chapters/clears.txt
  52. +26 −13 doc/specs/vulkan/chapters/cmdbuffers.txt
  53. +1 −3 doc/specs/vulkan/chapters/copies.txt
  54. +32 −22 doc/specs/vulkan/chapters/descriptorsets.txt
  55. +4 −4 doc/specs/vulkan/chapters/devsandqueues.txt
  56. +42 −15 doc/specs/vulkan/chapters/drawing.txt
  57. +126 −111 doc/specs/vulkan/chapters/features.txt
  58. +14 −10 doc/specs/vulkan/chapters/fragops.txt
  59. +2 −2 doc/specs/vulkan/chapters/framebuffer.txt
  60. +39 −59 doc/specs/vulkan/chapters/fundamentals.txt
  61. +4 −3 doc/specs/vulkan/chapters/fxvertex.txt
  62. +4 −1 doc/specs/vulkan/chapters/geometry.txt
  63. +3 −3 doc/specs/vulkan/chapters/initialization.txt
  64. +4 −4 doc/specs/vulkan/chapters/interfaces.txt
  65. +6 −6 doc/specs/vulkan/chapters/introduction.txt
  66. +3 −3 doc/specs/vulkan/chapters/memory.txt
  67. +22 −24 doc/specs/vulkan/chapters/pipelines.txt
  68. +46 −57 doc/specs/vulkan/chapters/primsrast.txt
  69. +10 −10 doc/specs/vulkan/chapters/queries.txt
  70. +13 −1 doc/specs/vulkan/chapters/renderpass.txt
  71. +2 −2 doc/specs/vulkan/chapters/resources.txt
  72. +6 −7 doc/specs/vulkan/chapters/shaders.txt
  73. +30 −26 doc/specs/vulkan/chapters/sparsemem.txt
  74. +88 −24 doc/specs/vulkan/chapters/synchronization.txt
  75. +26 −16 doc/specs/vulkan/chapters/tessellation.txt
  76. +111 −107 doc/specs/vulkan/chapters/textures.txt
  77. +44 −20 doc/specs/vulkan/chapters/vertexpostproc.txt
  78. +8 −40 doc/specs/vulkan/config/README.md
  79. +79 −0 doc/specs/vulkan/config/asciidoctor-pdf-monkeypatch.rb
  80. +33 −33 doc/specs/vulkan/config/attribs.txt
  81. +0 −110 doc/specs/vulkan/config/docbook-xsl/common.xsl
  82. +28 −0 doc/specs/vulkan/config/extDependency.sh
  83. +7 −11 doc/specs/vulkan/config/{math-asciidoc.conf → katex_replace.rb}
  84. +56 −0 doc/specs/vulkan/config/katex_replace/extension.rb
  85. +0 −116 doc/specs/vulkan/config/manpages.conf
  86. +0 −71 doc/specs/vulkan/config/math-docbook.conf
  87. +0 −27 doc/specs/vulkan/config/math.js
  88. +199 −203 doc/specs/vulkan/config/mathtest.txt
  89. +0 −301 doc/specs/vulkan/config/vkman.css
  90. +0 −136 doc/specs/vulkan/config/vkspec-dblatex.sty
  91. +0 −14 doc/specs/vulkan/config/vkspec-dblatex.xsl
  92. +0 −572 doc/specs/vulkan/config/vkspec-html.css
  93. +0 −382 doc/specs/vulkan/config/vkspec-xhtml.css
  94. +0 −116 doc/specs/vulkan/config/vkspec.conf
  95. +48 −0 doc/specs/vulkan/config/vulkan-macros.rb
  96. +240 −0 doc/specs/vulkan/config/vulkan-macros/extension.rb
  97. +3 −3 doc/specs/vulkan/copyright-spec.txt
  98. +8 −4 doc/specs/vulkan/genRef.py
  99. +3 −3 doc/specs/vulkan/genRelease
  100. +1 −0 doc/specs/vulkan/genspec.py
  101. BIN doc/specs/vulkan/images/icons/caution.png
  102. BIN doc/specs/vulkan/images/icons/example.png
  103. BIN doc/specs/vulkan/images/icons/home.png
  104. BIN doc/specs/vulkan/images/icons/important.png
  105. BIN doc/specs/vulkan/images/icons/next.png
  106. BIN doc/specs/vulkan/images/icons/note.png
  107. BIN doc/specs/vulkan/images/icons/prev.png
  108. BIN doc/specs/vulkan/images/icons/tip.png
  109. BIN doc/specs/vulkan/images/icons/up.png
  110. BIN doc/specs/vulkan/images/icons/warning.png
  111. +52 −52 doc/specs/vulkan/images/pipeline.svg
  112. +3 −3 doc/specs/vulkan/images/sparseimage.svg
  113. +4 −4 doc/specs/vulkan/images/sparseimage_alignedmipsize.svg
  114. +4 −4 doc/specs/vulkan/images/sparseimage_alignedmipsize_singlemiptail.svg
  115. +3 −3 doc/specs/vulkan/images/sparseimage_multiaspect.svg
  116. +4 −4 doc/specs/vulkan/images/sparseimage_singlemiptail.svg
  117. BIN doc/specs/vulkan/images/vulkantexture0.png
  118. +116 −116 doc/specs/vulkan/images/vulkantexture0.svg
  119. BIN doc/specs/vulkan/images/vulkantexture1.png
  120. BIN doc/specs/vulkan/images/vulkantexture2.png
  121. +1 −1 doc/specs/vulkan/installRelease
  122. +5 −51 doc/specs/vulkan/makeAllExts
  123. +33 −3 doc/specs/vulkan/makeExt
  124. +4 −21 doc/specs/vulkan/makeKHR
  125. +1 −1 doc/specs/vulkan/sandboxCopy
  126. +46 −29 doc/specs/vulkan/style/extensions.txt
  127. +21 −15 doc/specs/vulkan/style/markup.txt
  128. +2 −2 doc/specs/vulkan/style/naming.txt
  129. +71 −60 doc/specs/vulkan/style/writing.txt
  130. +24 −33 doc/specs/vulkan/styleguide.txt
  131. +8 −20 doc/specs/vulkan/vkspec.txt
  132. +23 −0 src/ext_loader/vulkan_ext.c
  133. +2 −0 src/spec/README.adoc
  134. +1 −6 src/spec/docgenerator.py
  135. +95 −0 src/spec/extDependency.py
  136. +93 −0 src/spec/indexExt.py
  137. +2 −0 src/spec/registry.txt
  138. +64 −19 src/spec/vk.xml
  139. +5 −5 src/vulkan/vulkan.h
@@ -0,0 +1,8 @@
# These bash scripts must use Unix-style line ending on all platforms.
doc/specs/vulkan/installRelease text eol=lf
doc/specs/vulkan/makeAllExts text eol=lf
doc/specs/vulkan/makeExt text eol=lf
doc/specs/vulkan/makeKHR text eol=lf
doc/specs/vulkan/sandboxCopy text eol=lf

*.sh text eol=lf
@@ -1826,3 +1826,89 @@ Other Issues:
usage text for these functions.
* Add the +<<VK_EXT_swapchain_colorspace>>+ extension defining common
color spaces.

-----------------------------------------------------

Change log for February 10, 2017 Vulkan 1.0.40 spec update:

* Bump API patch number and header version number to 40 for this update.
* There is a major build change in this release. We are now using the
Ruby-based ``asciidoctor'' implementation, rather than the Python-based
``asciidoc'' implementation, to process the specification. While the
actual specification markup changes were minimal, this requires a new
set of build tools and a very different installation process, especially
because we now use an experimental direct-to-PDF backend for Asciidoctor
instead of Docbook->dblatex->PDF. It is no longer possible to build the
Specification using asciidoc. See doc/specs/vulkan/README.adoc
for some guidance on installing the new toolchain components.
* There are some minor rendering issues in the PDF output due to teething
problems with the asciidoctor toolchain, especially with mathematical
equations. We are aware of these and working on them.

Github Issues:

* Updated sample code for the <<sparsememory-examples-basic,sparse
resource binding example>> (public issue 97).
* Modify line and point clipping behavior in the
<<vertexpostproc-clipping, Primitive Clipping>> section to allow for
pop-free behavior. The ability to check for which behavior is
implemented may be added a future feature or extension (public issue
113).
* Unify the discussions of implicit ordering throughout the spec, in
particular in the new sections <<drawing-primitive-order, Primitive
Order>>, <<primrast-order, Rasterization Order>>, and
<<synchronization-implicit, Implicit Synchronization Guarantees>>; the
discussion of <<synchronization-submission-order, submission order>>;
and references elsewhere to these sections (public issue 133).
* Clarify \<\<descriptorsets-compatibility,Pipeline Layout Compatibility>>
language and introduce the term ``identically defined'' (public issue
164).
* Add a dependency to the +VK_EXT_debug_marker+ extension that's needed to
reuse the object type enum from +VK_EXT_debug_report+, and moves the
definition of that enum into +VK_EXT_debug_report+ where it should be
(public issue 409).
* Remove redundant valid usage statement from slink:VkImageBlit (public
issue 421).
* Update GL_KHR_vulkan_glsl to allow the ternary operator to result in a
specialization constant (public issue 424).
* Fix valid usage for flink:VkPipelineShaderStageCreateInfo (public issue
426).
* Correct typo in New Objects list for <<VK_EXT_debug_report>> (public
issue 447).

Internal Issues:

* Moved to asciidoctor for spec builds (internal issue 121).
* Update style guide to describe where to put new extensions-specific
asciidoc files, and what to name them (internal issue 626).
* Add src/spec/indexExt.py to autogenerate registry index entries linking
into the 1.0-extensions specification, instead of maintaining the index
manually. (internal issue 642).
* Autogenerate extension dependencies and lists of all extensions and all
KHR extensions from the "supported" attributes in +vk.xml+. Execute
+make config/extDependency.sh+ from +doc/specs/vulkan+ when a supported
extension is added to vk.xml, to regenerate the dependency script. The
consequence is that specifying a single extension to the +makeExt+
script will automatically enable all extensions it depends on as well,
and that the +makeAllExts+ and +makeKHR+ scripts do not need to be
updated when a new extension is supported (internal issue 648).
* Put extension appendices all at the same asciidoc section level, so KHR
WSI extensions show up in the HTML index (internal issue 648).

Other Issues:

* Imbed images in the generated HTML specs instead of loading them from
the images/ directory.
* Fix missing EXT in extension name
(ename:VK_EXT_SWAPCHAIN_COLOR_SPACE_EXTENSION_NAME).
* Add new +VK_EXT_SMPTE_2086_metadata+ extension.
* In the <<platformCreateSurface_xlib,Xlib Surface>> section of the
+VK_KHR_xlib_surface+ specification, add language warning users that
they always need to call code:XinitThreads.
* Use the term "presentable image" (rather than "swapchain image")
consistently in +VK_KHR_swapchain+ and related extensions, and add a
glossary term defining it.
* Relocate the valid usage for samples of
flink:vkGetPhysicalDeviceSparseImageFormatProperties2KHR::pname:pFormatInfo
to be below the flink:VkPhysicalDeviceSparseImageFormatInfo2KHR
structure.
@@ -58,11 +58,9 @@ There are several make targets in doc/specs/vulkan :

* make html - Build one large HTML specification document.
* make pdf - Build one large PDF specification document.
* make chunked - Build an HTML document broken into one file per chapter.
* make manhtml - Make HTML API reference (all man pages as one big file).
* make manpdf - Make a one-giant PDF API reference.
* make manhtmlpages - Make man pages as one-file-per-API.
* make manpages - Make man pages as nroff Unix-style (real) man pages.
* make allchecks - Run the validation rules on the specification.

The outputs will be written to $(OUTDIR), which defaults to out/ at the root
@@ -33,8 +33,8 @@ Status

Version

Last Modified Date: 30-Aug-2016
Revision: 33
Last Modified Date: 26-Jan-2017
Revision: 34

Number

@@ -1055,6 +1055,7 @@ Changes to Chapter 5 of the OpenGL Shading Language Specification
* not ( ! )
* logical operations ( && , || , ^^ )
* comparison ( == , != )
- The ternary operator ( ? : )

Changes to Chapter 6 of the OpenGL Shading Language Specification

@@ -1329,6 +1330,8 @@ Revision History

Rev. Date Author Changes
---- ----------- ------- --------------------------------------------
34 26-Jan-2017 JohnK Allow the ternary operator to result in a
specialization constant
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

0 comments on commit 82e0f83

Please sign in to comment.
You can’t perform that action at this time.