Skip to content
Permalink
Browse files

Change log for January 23, 2017 Vulkan 1.0.39 spec update:

  * Bump API patch number and header version number to 39 for this update.

Github Issues:

  * Clarified that only accesses via the specified buffer/image subresource
    ranges are included in the access scopes (public issue 306).
  * Add missing valid usage statements for flink:vkCreateComputePipelines
    and flink:vkCreateGraphicsPipelines (public issue 427).

Internal Issues:

  * Add a Note to the <<invariance,Invariance>> appendix about a difference
    between OpenGL and Vulkan with regards to how primitives derived from
    offsets are handled (internal issue 355).
  * Add the +<<VK_KHR_get_physical_device_properties2>>+,
    +<<VK_KHR_maintenance1>>+, and +<<VK_KHR_shader_draw_parameters>>+
    extensions (internal issue 448).
  * Add the +<<VK_EXT_shader_subgroup_vote>>+ and
    +<<VK_EXT_shader_subgroup_ballot>>+ extensions (internal issue 449).
  * Update the texture level-of-detail equation in the
    <<textures-scale-factor,Scale Factor Operation>> section to better
    approximate the ellipse major and minor axes (internal issue 547).
  * Forbid non-explicitly allowed uses of interface decorations in the
    introduction to the <<interfaces,Shader Interfaces>> chapter (internal
    issue 607).
  * Replace use of MathJax with KaTeX, for improved load-time performance as
    well as avoiding the scrolling-and-scrolling behavior due to MathJax
    asynchronous rendering when loading at an anchor inside the spec. This
    change also requires moving to HTML5 output for the spec instead of
    XHTML, and there is a visible difference in that the chapter navigation
    index is now in a scrollable sidebar instead of at the top of the
    document. We may or may not retain the nav sidebar based on feedback
    (internal issue 613).
  * Improve consistency of markup and formatting in extension appendices
    (internal issue 631).

Other Issues:

  * Add explicit valid usage statements to slink:VkImageCopy requiring that
    the source and destination layer ranges be contained in their respective
    source and destination images.
  * Add valid usage language for swapchain of flink:vkAcquireNextImage. If
    the swapchain has been replaced, then it should not be passed to
    flink:vkAcquireNextImage.
  * Add a valid usage statement to flink:vkCreateImageView, that the image
    must have been created with an appropriate usage bit set.
  * Noted that slink:VkDisplayPresentInfoKHR is a valid extension of
    slink:VkPresentInfoKHR in the <<wsi_swapchain,WSI Swapchain>> section.
  * Update valid usage for flink:vkCmdSetViewport and flink:vkCmdSetScissor
    to account for the multiple viewport feature. If the feature is not
    enabled, the parameters for these functions have required values that
    are defined in the <<features-features-multiViewport,multiple
    viewports>> section of the spec but were not reflected in the valid
    usage text for these functions.
  * Add the +<<VK_EXT_swapchain_colorspace>>+ extension defining common
    color spaces.
  • Loading branch information...
oddhack committed Jan 18, 2017
1 parent 70b659d commit ca4abe0d34ca8ed8410c65c177f8658da183576d
Showing with 16,686 additions and 1,706 deletions.
  1. +61 −0 ChangeLog.txt
  2. +3 −3 README.md
  3. +34 −85 doc/specs/vulkan/Makefile
  4. +32 −13 doc/specs/vulkan/README.adoc
  5. +56 −22 doc/specs/vulkan/README.html
  6. +9 −9 doc/specs/vulkan/appendices/VK_AMD_draw_indirect_count.txt
  7. +6 −6 doc/specs/vulkan/appendices/VK_AMD_gcn_shader.txt
  8. +8 −9 doc/specs/vulkan/appendices/VK_AMD_gpu_shader_half_float.txt
  9. +7 −7 doc/specs/vulkan/appendices/VK_AMD_negative_viewport_height.txt
  10. +18 −18 doc/specs/vulkan/appendices/VK_AMD_rasterization_order.txt
  11. +9 −9 doc/specs/vulkan/appendices/VK_AMD_shader_ballot.txt
  12. +8 −8 doc/specs/vulkan/appendices/VK_AMD_shader_explicit_vertex_parameter.txt
  13. +8 −8 doc/specs/vulkan/appendices/VK_AMD_shader_trinary_minmax.txt
  14. +80 −0 doc/specs/vulkan/appendices/VK_EXT_acquire_xlib_display.txt
  15. +23 −25 doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt
  16. +7 −7 doc/specs/vulkan/appendices/VK_EXT_debug_report.txt
  17. +73 −0 doc/specs/vulkan/appendices/VK_EXT_direct_mode_display.txt
  18. +92 −0 doc/specs/vulkan/appendices/VK_EXT_display_control.txt
  19. +58 −0 doc/specs/vulkan/appendices/VK_EXT_display_surface_counter.txt
  20. +127 −0 doc/specs/vulkan/appendices/VK_EXT_shader_subgroup_ballot.txt
  21. +151 −0 doc/specs/vulkan/appendices/VK_EXT_shader_subgroup_vote.txt
  22. +164 −0 doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt
  23. +6 −6 doc/specs/vulkan/appendices/VK_EXT_validation_flags.txt
  24. +3 −3 doc/specs/vulkan/appendices/VK_IMG_filter_cubic.txt
  25. +8 −8 doc/specs/vulkan/appendices/VK_KHR_android_surface/vk_khr_android_surface.txt
  26. +124 −120 doc/specs/vulkan/appendices/VK_KHR_display/vk_khr_display.txt
  27. +41 −40 doc/specs/vulkan/appendices/VK_KHR_display_swapchain/vk_khr_display_swapchain.txt
  28. +150 −0 doc/specs/vulkan/appendices/VK_KHR_get_physical_device_properties2.txt
  29. +108 −0 doc/specs/vulkan/appendices/VK_KHR_maintenance1.txt
  30. +9 −10 doc/specs/vulkan/appendices/VK_KHR_mir_surface/vk_khr_mir_surface.txt
  31. +6 −7 doc/specs/vulkan/appendices/VK_KHR_sampler_mirror_clamp_to_edge.txt
  32. +116 −0 doc/specs/vulkan/appendices/VK_KHR_shader_draw_parameters.txt
  33. +46 −47 doc/specs/vulkan/appendices/VK_KHR_surface/vk_khr_surface.txt
  34. +9 −1 doc/specs/vulkan/appendices/VK_KHR_surface/wsi.txt
  35. +310 −318 doc/specs/vulkan/appendices/VK_KHR_swapchain/vk_khr_swapchain.txt
  36. +11 −11 doc/specs/vulkan/appendices/VK_KHR_wayland_surface/vk_khr_wayland_surface.txt
  37. +11 −12 doc/specs/vulkan/appendices/VK_KHR_win32_surface/vk_khr_win32_surface.txt
  38. +12 −12 doc/specs/vulkan/appendices/VK_KHR_xcb_surface/vk_khr_xcb_surface.txt
  39. +12 −12 doc/specs/vulkan/appendices/VK_KHR_xlib_surface/vk_khr_xlib_surface.txt
  40. +77 −0 doc/specs/vulkan/appendices/VK_NN_vi_surface/vk_nn_vi_surface.txt
  41. +155 −144 doc/specs/vulkan/appendices/VK_NVX_device_generated_commands.txt
  42. +3 −4 doc/specs/vulkan/appendices/VK_NV_dedicated_allocation.txt
  43. +30 −31 doc/specs/vulkan/appendices/VK_NV_external_memory.txt
  44. +29 −29 doc/specs/vulkan/appendices/VK_NV_external_memory_capabilities.txt
  45. +42 −44 doc/specs/vulkan/appendices/VK_NV_external_memory_win32.txt
  46. +3 −4 doc/specs/vulkan/appendices/VK_NV_glsl_shader.txt
  47. +6 −6 doc/specs/vulkan/appendices/VK_NV_win32_keyed_mutex.txt
  48. +4 −1 doc/specs/vulkan/appendices/boilerplate.txt
  49. +1 −1 doc/specs/vulkan/appendices/compressedtex.txt
  50. +1 −1 doc/specs/vulkan/appendices/credits.txt
  51. +37 −2 doc/specs/vulkan/appendices/extensions.txt
  52. +49 −34 doc/specs/vulkan/appendices/glossary.txt
  53. +17 −2 doc/specs/vulkan/appendices/invariance.txt
  54. +28 −1 doc/specs/vulkan/appendices/spirvenv.txt
  55. +55 −0 doc/specs/vulkan/chapters/VK_EXT_acquire_xlib_display/acquire_xlib_display.txt
  56. +8 −6 doc/specs/vulkan/chapters/VK_EXT_debug_report.txt
  57. +22 −0 doc/specs/vulkan/chapters/VK_EXT_direct_mode_display/acquire_release_displays.txt
  58. +40 −0 doc/specs/vulkan/chapters/VK_EXT_display_control/display_control.txt
  59. +87 −0 doc/specs/vulkan/chapters/VK_EXT_display_control/fence_events.txt
  60. +46 −0 doc/specs/vulkan/chapters/VK_EXT_display_control/swapchain_counters.txt
  61. +57 −0 doc/specs/vulkan/chapters/VK_EXT_display_surface_counter/surface_capabilities.txt
  62. +6 −6 doc/specs/vulkan/chapters/VK_IMG_filter_cubic/filter_cubic_texel_filtering.txt
  63. +5 −5 doc/specs/vulkan/chapters/VK_IMG_filter_cubic/filter_cubic_texel_selection.txt
  64. +1 −1 doc/specs/vulkan/chapters/VK_KHR_android_surface/platformCreateSurface_android.txt
  65. +8 −1 doc/specs/vulkan/chapters/VK_KHR_display/display.txt
  66. +1 −1 doc/specs/vulkan/chapters/VK_KHR_display_swapchain/create_shared_swapchains.txt
  67. +1 −1 doc/specs/vulkan/chapters/VK_KHR_display_swapchain/display_swapchain_present.txt
  68. +1 −1 doc/specs/vulkan/chapters/VK_KHR_mir_surface/platformCreateSurface_mir.txt
  69. +1 −1 doc/specs/vulkan/chapters/VK_KHR_mir_surface/platformQuerySupport_mir.txt
  70. +44 −4 doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt
  71. +8 −1 doc/specs/vulkan/chapters/VK_KHR_swapchain/wsi.txt
  72. +1 −1 doc/specs/vulkan/chapters/VK_KHR_wayland_surface/platformCreateSurface_wayland.txt
  73. +1 −1 doc/specs/vulkan/chapters/VK_KHR_wayland_surface/platformQuerySupport_wayland.txt
  74. +1 −1 doc/specs/vulkan/chapters/VK_KHR_win32_surface/platformCreateSurface_win32.txt
  75. +1 −1 doc/specs/vulkan/chapters/VK_KHR_win32_surface/platformQuerySupport_win32.txt
  76. +1 −1 doc/specs/vulkan/chapters/VK_KHR_xcb_surface/platformCreateSurface_xcb.txt
  77. +1 −1 doc/specs/vulkan/chapters/VK_KHR_xcb_surface/platformQuerySupport_xcb.txt
  78. +1 −1 doc/specs/vulkan/chapters/VK_KHR_xlib_surface/platformCreateSurface_xlib.txt
  79. +1 −1 doc/specs/vulkan/chapters/VK_KHR_xlib_surface/platformQuerySupport_xlib.txt
  80. +55 −0 doc/specs/vulkan/chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt
  81. +8 −0 doc/specs/vulkan/chapters/VK_NN_vi_surface/platformQuerySupport_vi.txt
  82. +21 −1 doc/specs/vulkan/chapters/clears.txt
  83. +69 −1 doc/specs/vulkan/chapters/cmdbuffers.txt
  84. +85 −1 doc/specs/vulkan/chapters/copies.txt
  85. +14 −1 doc/specs/vulkan/chapters/descriptorsets.txt
  86. +90 −1 doc/specs/vulkan/chapters/devsandqueues.txt
  87. +1 −1 doc/specs/vulkan/chapters/dispatch.txt
  88. +1 −1 doc/specs/vulkan/chapters/drawing.txt
  89. +5 −1 doc/specs/vulkan/chapters/extensions.txt
  90. +359 −8 doc/specs/vulkan/chapters/features.txt
  91. +5 −1 doc/specs/vulkan/chapters/fragops.txt
  92. +1 −1 doc/specs/vulkan/chapters/framebuffer.txt
  93. +5 −1 doc/specs/vulkan/chapters/fundamentals.txt
  94. +1 −1 doc/specs/vulkan/chapters/fxvertex.txt
  95. +1 −1 doc/specs/vulkan/chapters/geometry.txt
  96. +25 −1 doc/specs/vulkan/chapters/initialization.txt
  97. +200 −2 doc/specs/vulkan/chapters/interfaces.txt
  98. +1 −1 doc/specs/vulkan/chapters/introduction.txt
  99. +36 −1 doc/specs/vulkan/chapters/memory.txt
  100. +9 −1 doc/specs/vulkan/chapters/pipelines.txt
  101. +12 −12 doc/specs/vulkan/chapters/primsrast.txt
  102. +1 −1 doc/specs/vulkan/chapters/queries.txt
  103. +5 −1 doc/specs/vulkan/chapters/renderpass.txt
  104. +73 −1 doc/specs/vulkan/chapters/resources.txt
  105. +1 −1 doc/specs/vulkan/chapters/samplers.txt
  106. +1 −1 doc/specs/vulkan/chapters/shaders.txt
  107. +74 −1 doc/specs/vulkan/chapters/sparsemem.txt
  108. +41 −23 doc/specs/vulkan/chapters/synchronization.txt
  109. +1 −1 doc/specs/vulkan/chapters/tessellation.txt
  110. +176 −173 doc/specs/vulkan/chapters/textures.txt
  111. +25 −1 doc/specs/vulkan/chapters/vertexpostproc.txt
  112. +1 −1 doc/specs/vulkan/checkLinks.py
  113. +0 −61 doc/specs/vulkan/config/README
  114. +53 −0 doc/specs/vulkan/config/README.md
  115. +0 −33 doc/specs/vulkan/config/docbook-xsl/chunked.xsl
  116. +0 −31 doc/specs/vulkan/config/docbook-xsl/manpage.xsl
  117. +0 −30 doc/specs/vulkan/config/docbook-xsl/xhtml.xsl
  118. +1 −1 doc/specs/vulkan/config/manpages.conf
  119. +4 −3 doc/specs/vulkan/config/{mathjax-asciidoc.conf → math-asciidoc.conf}
  120. +3 −2 doc/specs/vulkan/config/{mathjax-docbook.conf → math-docbook.conf}
  121. +27 −0 doc/specs/vulkan/config/math.js
  122. +0 −8 doc/specs/vulkan/config/mathjax.js
  123. +951 −0 doc/specs/vulkan/config/mathtest.txt
  124. +1 −1 doc/specs/vulkan/config/vkspec-dblatex.sty
  125. +1 −1 doc/specs/vulkan/config/vkspec.conf
  126. +1 −1 doc/specs/vulkan/copyright-ccby.txt
  127. +1 −1 doc/specs/vulkan/copyright-spec.txt
  128. +3 −3 doc/specs/vulkan/genRef.py
  129. +4 −4 doc/specs/vulkan/genRelease
  130. +16 −2 doc/specs/vulkan/genspec.py
  131. +1 −1 doc/specs/vulkan/insertTags.py
  132. +1 −1 doc/specs/vulkan/installRelease
  133. +68 −0 doc/specs/vulkan/katex/README.md
  134. +1 −0 doc/specs/vulkan/katex/contrib/auto-render.min.js
  135. BIN doc/specs/vulkan/katex/fonts/KaTeX_AMS-Regular.eot
  136. BIN doc/specs/vulkan/katex/fonts/KaTeX_AMS-Regular.ttf
  137. BIN doc/specs/vulkan/katex/fonts/KaTeX_AMS-Regular.woff
  138. BIN doc/specs/vulkan/katex/fonts/KaTeX_AMS-Regular.woff2
  139. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Bold.eot
  140. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Bold.ttf
  141. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Bold.woff
  142. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Bold.woff2
  143. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Regular.eot
  144. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Regular.ttf
  145. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Regular.woff
  146. BIN doc/specs/vulkan/katex/fonts/KaTeX_Caligraphic-Regular.woff2
  147. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Bold.eot
  148. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Bold.ttf
  149. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Bold.woff
  150. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Bold.woff2
  151. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Regular.eot
  152. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Regular.ttf
  153. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Regular.woff
  154. BIN doc/specs/vulkan/katex/fonts/KaTeX_Fraktur-Regular.woff2
  155. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Bold.eot
  156. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Bold.ttf
  157. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Bold.woff
  158. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Bold.woff2
  159. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Italic.eot
  160. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Italic.ttf
  161. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Italic.woff
  162. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Italic.woff2
  163. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Regular.eot
  164. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Regular.ttf
  165. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Regular.woff
  166. BIN doc/specs/vulkan/katex/fonts/KaTeX_Main-Regular.woff2
  167. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-BoldItalic.eot
  168. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-BoldItalic.ttf
  169. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-BoldItalic.woff
  170. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-BoldItalic.woff2
  171. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Italic.eot
  172. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Italic.ttf
  173. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Italic.woff
  174. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Italic.woff2
  175. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Regular.eot
  176. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Regular.ttf
  177. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Regular.woff
  178. BIN doc/specs/vulkan/katex/fonts/KaTeX_Math-Regular.woff2
  179. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Bold.eot
  180. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Bold.ttf
  181. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Bold.woff
  182. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Bold.woff2
  183. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Italic.eot
  184. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Italic.ttf
  185. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Italic.woff
  186. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Italic.woff2
  187. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Regular.eot
  188. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Regular.ttf
  189. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Regular.woff
  190. BIN doc/specs/vulkan/katex/fonts/KaTeX_SansSerif-Regular.woff2
  191. BIN doc/specs/vulkan/katex/fonts/KaTeX_Script-Regular.eot
  192. BIN doc/specs/vulkan/katex/fonts/KaTeX_Script-Regular.ttf
  193. BIN doc/specs/vulkan/katex/fonts/KaTeX_Script-Regular.woff
  194. BIN doc/specs/vulkan/katex/fonts/KaTeX_Script-Regular.woff2
  195. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size1-Regular.eot
  196. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size1-Regular.ttf
  197. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size1-Regular.woff
  198. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size1-Regular.woff2
  199. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size2-Regular.eot
  200. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size2-Regular.ttf
  201. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size2-Regular.woff
  202. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size2-Regular.woff2
  203. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size3-Regular.eot
  204. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size3-Regular.ttf
  205. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size3-Regular.woff
  206. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size3-Regular.woff2
  207. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size4-Regular.eot
  208. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size4-Regular.ttf
  209. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size4-Regular.woff
  210. BIN doc/specs/vulkan/katex/fonts/KaTeX_Size4-Regular.woff2
  211. BIN doc/specs/vulkan/katex/fonts/KaTeX_Typewriter-Regular.eot
  212. BIN doc/specs/vulkan/katex/fonts/KaTeX_Typewriter-Regular.ttf
  213. BIN doc/specs/vulkan/katex/fonts/KaTeX_Typewriter-Regular.woff
  214. BIN doc/specs/vulkan/katex/fonts/KaTeX_Typewriter-Regular.woff2
  215. +976 −0 doc/specs/vulkan/katex/katex.css
  216. +9,075 −0 doc/specs/vulkan/katex/katex.js
  217. +1 −0 doc/specs/vulkan/katex/katex.min.css
  218. +4 −0 doc/specs/vulkan/katex/katex.min.js
  219. +14 −1 doc/specs/vulkan/makeAllExts
  220. +1 −1 doc/specs/vulkan/makeExt
  221. +4 −1 doc/specs/vulkan/makeKHR
  222. +1 −1 doc/specs/vulkan/man/copyright-ccby.txt
  223. +4 −0 doc/specs/vulkan/man/footer.txt
  224. +1 −1 doc/specs/vulkan/refDesc.py
  225. +1 −1 doc/specs/vulkan/reflib.py
  226. +1 −1 doc/specs/vulkan/reflow.py
  227. +1 −1 doc/specs/vulkan/style/extensions.txt
  228. +1 −1 doc/specs/vulkan/style/markup.txt
  229. +1 −1 doc/specs/vulkan/style/naming.txt
  230. +37 −13 doc/specs/vulkan/style/writing.txt
  231. +1 −1 doc/specs/vulkan/styleguide.txt
  232. +5 −2 doc/specs/vulkan/vkspec.txt
  233. +10 −10 out/index.html
  234. +316 −1 src/ext_loader/vulkan_ext.c
  235. +1 −1 src/ext_loader/vulkan_ext.h
  236. +1 −1 src/spec/Makefile
  237. +1 −1 src/spec/cgenerator.py
  238. +1 −1 src/spec/docgenerator.py
  239. +1 −1 src/spec/extensionStubSource.py
  240. +1 −1 src/spec/generator.py
  241. +2 −2 src/spec/genvk.py
  242. +1 −1 src/spec/hostsyncgenerator.py
  243. +1 −1 src/spec/pygenerator.py
  244. +1 −1 src/spec/realign.py
  245. +1 −1 src/spec/reg.py
  246. +1 −1 src/spec/registry.conf
  247. +1 −1 src/spec/registry.rnc
  248. +4 −4 src/spec/registry.txt
  249. +2 −2 src/spec/validitygenerator.py
  250. +408 −42 src/spec/vk.xml
  251. +1 −1 src/vulkan/vk_platform.h
  252. +365 −2 src/vulkan/vulkan.h
@@ -1765,3 +1765,64 @@ Other Issues:

* Vulkan(R) is now a registered trademark symbol, and this is reflected in
documents and copyright statements.

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

Change log for January 23, 2017 Vulkan 1.0.39 spec update:

* Bump API patch number and header version number to 39 for this update.

Github Issues:

* Clarified that only accesses via the specified buffer/image subresource
ranges are included in the access scopes (public issue 306).
* Add missing valid usage statements for flink:vkCreateComputePipelines
and flink:vkCreateGraphicsPipelines (public issue 427).

Internal Issues:

* Add a Note to the <<invariance,Invariance>> appendix about a difference
between OpenGL and Vulkan with regards to how primitives derived from
offsets are handled (internal issue 355).
* Add the +<<VK_KHR_get_physical_device_properties2>>+,
+<<VK_KHR_maintenance1>>+, and +<<VK_KHR_shader_draw_parameters>>+
extensions (internal issue 448).
* Add the +<<VK_EXT_shader_subgroup_vote>>+ and
+<<VK_EXT_shader_subgroup_ballot>>+ extensions (internal issue 449).
* Update the texture level-of-detail equation in the
<<textures-scale-factor,Scale Factor Operation>> section to better
approximate the ellipse major and minor axes (internal issue 547).
* Forbid non-explicitly allowed uses of interface decorations in the
introduction to the <<interfaces,Shader Interfaces>> chapter (internal
issue 607).
* Replace use of MathJax with KaTeX, for improved load-time performance as
well as avoiding the scrolling-and-scrolling behavior due to MathJax
asynchronous rendering when loading at an anchor inside the spec. This
change also requires moving to HTML5 output for the spec instead of
XHTML, and there is a visible difference in that the chapter navigation
index is now in a scrollable sidebar instead of at the top of the
document. We may or may not retain the nav sidebar based on feedback
(internal issue 613).
* Improve consistency of markup and formatting in extension appendices
(internal issue 631).

Other Issues:

* Add explicit valid usage statements to slink:VkImageCopy requiring that
the source and destination layer ranges be contained in their respective
source and destination images.
* Add valid usage language for swapchain of flink:vkAcquireNextImage. If
the swapchain has been replaced, then it should not be passed to
flink:vkAcquireNextImage.
* Add a valid usage statement to flink:vkCreateImageView, that the image
must have been created with an appropriate usage bit set.
* Noted that slink:VkDisplayPresentInfoKHR is a valid extension of
slink:VkPresentInfoKHR in the <<wsi_swapchain,WSI Swapchain>> section.
* Update valid usage for flink:vkCmdSetViewport and flink:vkCmdSetScissor
to account for the multiple viewport feature. If the feature is not
enabled, the parameters for these functions have required values that
are defined in the <<features-features-multiViewport,multiple
viewports>> section of the spec but were not reflected in the valid
usage text for these functions.
* Add the +<<VK_EXT_swapchain_colorspace>>+ extension defining common
color spaces.
@@ -1,5 +1,5 @@
Vulkan^(R)^ API Documentation Project
=====================================
Vulkan<sup>:registered:</sup> API Documentation Project
=======================================================

This repository contains formal documentation of the Vulkan API. This
includes the main API Specification, the reference (man) pages, the XML API
@@ -56,7 +56,7 @@ Cygwin running under Microsoft Windows.

There are several make targets in doc/specs/vulkan :

* make xhtml - Build one large HTML specification document.
* 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).
@@ -1,4 +1,4 @@
# Copyright (c) 2014-2016 The Khronos Group Inc.
# Copyright (c) 2014-2017 The Khronos Group Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -31,25 +31,22 @@ EXTOPTIONS := $(foreach ext,$(EXTS),-extension $(ext))
APITITLE =

# The default 'all' target builds the following sub-targets:
# xhtml - XHTML single-page API specification
# pdf - PDF single-page API specification
# styleguide - HTML single-page "Documentation and Extensions" guide
# manhtml - XHTML single-page reference guide
# styleguide - HTML5 single-page "Documentation and Extensions" guide
# manhtml - HTML5 single-page reference guide
# manpdf - PDF reference guide
# manhtmlpages - XHTML separate per-feature reference pages
# manhtmlpages - HTML5 separate per-feature reference pages
# checkinc - validator script for asciidoc include files
# checklinks - validator script for asciidoc xrefs
#
# The following targets are supported, but not invoked by default:
# html - HTML5 single-page API specification
# chunked - XHTML chunked (page per section) API specification
# manpages - nroff Unix 'man' format separate per-feature reference pages

all: alldocs allchecks

alldocs: allspecs allman

allspecs: xhtml pdf styleguide
allspecs: html pdf styleguide

allman: manhtml manpdf manhtmlpages

@@ -74,15 +71,10 @@ ECHO = echo

# Target directories for output files
# HTMLDIR - 'html' target
# XHTMLDIR - 'xhtml' target
# CHUNKDIR - 'chunked' target
# PDFDIR - 'pdf' target
# CHECKDIR - 'allchecks' target
# STYLEXHTMLDIR - 'styleguide' target
OUTDIR := ../../../out/1.0
HTMLDIR := $(OUTDIR)/html
XHTMLDIR := $(OUTDIR)/xhtml
CHUNKDIR := $(OUTDIR)/chunked
PDFDIR := $(OUTDIR)/pdf
CHECKDIR := $(OUTDIR)/checks
# Images used in the API spec
@@ -103,17 +95,17 @@ KEEP =
# EXTATTRIBS sets attributes for enabled extensions (set above based on
# $(EXTENSIONS))
# CONFIG Vulkan-specific Asciidoc macros. File used depends on target.
# ADOCOPTS options for asciidoc->HTML output
# ADOCDBOPTS options for asciidoc->XHTML or PDF output via docbook
# ADOCOPTS options for asciidoc->HTML5 output
# ADOCDBOPTS options for asciidoc->PDF output via docbook
XMLLINT = --no-xmllint
NOTEOPTS = -a editing-notes -a implementation-guide
ATTRIBOPTS = -a apirevision="$(SPECREVISION)" \
-a apititle="$(APITITLE)" \
-a mathjax $(EXTATTRIBS)
-a katex $(EXTATTRIBS)
CONFIG = config/vkspec.conf
ADOCOPTS = $(ATTRIBOPTS) $(NOTEOPTS) -f config/mathjax-asciidoc.conf \
ADOCOPTS = $(ATTRIBOPTS) $(NOTEOPTS) -f config/math-asciidoc.conf \
-f $(CONFIG) $(VERBOSE)
ADOCDBOPTS = $(ATTRIBOPTS) $(NOTEOPTS) -f config/mathjax-docbook.conf \
ADOCDBOPTS = $(ATTRIBOPTS) $(NOTEOPTS) -f config/math-docbook.conf \
-f $(CONFIG) $(VERBOSE)

# All the options except the first are taken from a2x defaults
@@ -124,29 +116,24 @@ XSLTOPTS = \
--stringparam admon.textlabel 0 \
--stringparam admon.graphics 1

# XSL customizing Asciibook XSL to pass through equations and add
# MathJax. This varies depending on target type.
XHTMLXSL = config/docbook-xsl/xhtml.xsl
CHUNKXSL = config/docbook-xsl/chunked.xsl
MANPAGEXSL = config/docbook-xsl/manpage.xsl

# dblatex options, passed directly to dblatex
# dblatex options
DBLATEXOPTS := $(KEEP) -V -T db2latex -I. -I images -I images/icons -s $(DBLATEXPREFIX)/asciidoc-dblatex.sty

# Misc. files to clean up (see 'checkinc' target below)
DIRT = $(SPECVERSION)

.PHONY: directories

# Images and icons that are used in or referenced by targets.
# Images, icons, and scripts that are used in or referenced by targets.
# For some targets they must be copied to output directories.
ICONFILES := $(wildcard $(ICONPATH)/*.png)
PNGFILES := $(ICONFILES) $(wildcard $(IMAGEPATH)/*.png)
# Don't use vulkantexture0.svg as a source SVG file, PNG is available
SVGFILES := $(filter-out $(IMAGEPATH)/vulkantexture0.svg,$(wildcard $(IMAGEPATH)/*.svg))
PDFFILES := $(SVGFILES:.svg=.pdf)
KATEX := katex

# File suffix for image targets for HTML and PDF Builds - Asciidoc {svgtype} attribute
# File suffix for image targets for HTML5 and PDF Builds - Asciidoc {svgtype} attribute
SVGTYPEHTML := svg
SVGTYPEPDF := pdf
# Top-level spec source file
@@ -160,55 +147,32 @@ 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.38
SPECREVISION = 1.0.39
SPECREMARK =

# README.md is a proxy for all the katex files that need to be installed
katexinst: $(OUTDIR)/katex/README.md

$(OUTDIR)/katex/README.md: katex/README.md
$(QUIET)$(MKDIR) $(OUTDIR)
$(QUIET)$(CP) -rf katex $(OUTDIR)

# Spec targets
# There is some complexity to try and avoid short virtual targets like 'html'
# causing specs to *always* be regenerated.

html: $(HTMLDIR)/vkspec.html $(TOPDOC) $(COMMONDOCS)

$(HTMLDIR)/vkspec.html: $(CONFIG) $(SPECVERSION) $(TOPDOC) $(COMMONDOCS)
$(HTMLDIR)/vkspec.html: $(CONFIG) $(SPECVERSION) $(TOPDOC) $(COMMONDOCS) katexinst
$(QUIET)$(MKDIR) $(HTMLDIR)/images/icons
$(QUIET)$(ASCIIDOC) -b html5 $(ADOCOPTS) \
-a themedir=$(CURDIR)/config -a theme=vkspec-html \
-a katexpath=../katex \
-o $(HTMLDIR)/vkspec.html -a svgpdf=$(SVGTYPEHTML) $(TOPDOC)
# Copy resource files in explicitly
$(QUIET)$(CP) $(SVGFILES) $(PNGFILES) $(HTMLDIR)/images
$(QUIET)$(CP) $(ICONFILES) $(HTMLDIR)/images/icons

xhtml: $(XHTMLDIR)/vkspec.html $(TOPDOC) $(COMMONDOCS)

$(XHTMLDIR)/vkspec.html: $(CONFIG) $(SPECVERSION) $(TOPDOC) $(COMMONDOCS)
$(QUIET)$(MKDIR) $(XHTMLDIR)/images/icons $(XHTMLDIR)/config
$(QUIET)$(ASCIIDOC) --backend docbook $(ADOCDBOPTS) \
-a a2x-format=xhtml -a svgpdf=$(SVGTYPEHTML) \
-o $(XHTMLDIR)/vkspec.xml $(TOPDOC)
$(QUIET)$(XSLTPROC) $(XSLTOPTS) -o $@ $(XHTMLXSL) \
$(XHTMLDIR)/vkspec.xml
# Copy resource files in explicitly
$(QUIET)$(CP) config/vkspec-xhtml.css $(XHTMLDIR)/config/
$(QUIET)$(CP) $(SVGFILES) $(PNGFILES) $(XHTMLDIR)/images
$(QUIET)$(CP) $(ICONFILES) $(XHTMLDIR)/images/icons
$(QUIET)$(RM) $(XHTMLDIR)/vkspec.xml

chunked: $(CHUNKDIR)/index.html $(TOPDOC) $(COMMONDOCS)

$(CHUNKDIR)/index.html: $(CONFIG) $(SPECVERSION) $(TOPDOC) $(COMMONDOCS)
$(QUIET)$(MKDIR) $(CHUNKDIR)/images/icons $(CHUNKDIR)/config
$(QUIET)$(ASCIIDOC) --backend docbook $(ADOCDBOPTS) \
-a a2x-format=chunked -a svgpdf=$(SVGTYPEHTML) \
-o $(CHUNKDIR)/vkspec.xml $(TOPDOC)
$(QUIET)$(XSLTPROC) $(XSLTOPTS) \
--stringparam base.dir $(CHUNKDIR)/ \
-o $@ $(CHUNKXSL) $(CHUNKDIR)/vkspec.xml
# Copy resource files in explicitly
$(QUIET)$(CP) config/vkspec-xhtml.css $(CHUNKDIR)/config/
$(QUIET)$(CP) $(SVGFILES) $(PNGFILES) $(CHUNKDIR)/images
$(QUIET)$(CP) $(ICONFILES) $(CHUNKDIR)/images/icons
$(QUIET)$(RM) $(CHUNKDIR)/vkspec.xml

pdf: $(PDFDIR)/vkspec.pdf

$(PDFDIR)/vkspec.pdf: $(CONFIG) $(SPECVERSION) $(TOPDOC) $(COMMONDOCS) $(PDFFILES)
@@ -234,7 +198,7 @@ $(SPECVERSION):
$(QUIET)echo ":revremark: $(SPECREMARK) Git branch information not available" >> $@
else
# Could use `git log -1 --format="%cd"` to get branch commit date
# This used to be a dependency in the spec html/chunked/pdf targets,
# This used to be a dependency in the spec html/pdf targets,
# but that's likely to lead to merge conflicts. Just regenerate
# when pushing a new spec for review to the sandbox.
# The dependency on HEAD is per the suggestion in
@@ -254,10 +218,11 @@ STYLEFILES = $(wildcard style/[A-Za-z]*.txt)

styleguide: $(OUTDIR)/styleguide.html

$(OUTDIR)/styleguide.html: $(CONFIG) $(SPECVERSION) $(STYLESRC) $(STYLEFILES) $(GENINCLUDE) $(GENDEPENDS)
$(OUTDIR)/styleguide.html: $(CONFIG) $(SPECVERSION) $(STYLESRC) $(STYLEFILES) $(GENINCLUDE) $(GENDEPENDS) katexinst
$(QUIET)$(MKDIR) $(OUTDIR)
$(QUIET)$(ASCIIDOC) -b html5 $(ADOCOPTS) \
-a themedir=$(CURDIR)/config -a theme=vkspec-html \
-a katexpath=katex \
-o $@ -a svgpdf=$(SVGTYPEHTML) \
$(STYLESRC)

@@ -274,7 +239,7 @@ reflow:
clean: clean_html clean_pdf clean_man clean_checks clean_generated clean_dirt

clean_html:
$(QUIET)$(RMRF) $(HTMLDIR) $(XHTMLDIR) $(CHUNKDIR)
$(QUIET)$(RMRF) $(HTMLDIR) $(OUTDIR)/katex
$(QUIET)$(RM) $(OUTDIR)/apispec.html $(OUTDIR)/styleguide.html

clean_pdf:
@@ -326,25 +291,7 @@ man/apispec.txt: $(CHAPTERS) genRef.py reflib.py vkapi.py

# These dependencies don't take into account include directives

# These targets are Unix 'man' nroff source, and are essentially useless
# since the ref pages contain both LaTeX math equations and images.

MANPAGEDIR := $(OUTDIR)/man/$(MANSECTION)
MANPAGES = $(MANSOURCES:$(MANDIR)/%.txt=$(MANPAGEDIR)/%.$(MANSECTION))

manpages: man/apispec.txt $(MANPAGES)

$(MANPAGEDIR)/%.$(MANSECTION): CONFIG=config/manpages.conf

$(MANPAGEDIR)/%.$(MANSECTION): $(MANDIR)/%.txt $(MANCOPYRIGHT) config/manpages.conf $(GENINCLUDE) $(GENDEPENDS)
$(QUIET)$(MKDIR) $(MANPAGEDIR)
$(QUIET)$(ASCIIDOC) --backend docbook $(ADOCDBOPTS) --doctype manpage \
-a a2x-format=manpage -a svgpdf=$(SVGTYPEHTML) \
-o $@.xml $<
$(QUIET)$(XSLTPROC) $(XSLTOPTS) -o $@ $(MANPAGEXSL) $@.xml
$(QUIET)$(RM) $@.xml

# These targets are HTML ref pages
# These targets are HTML5 ref pages

MANHTMLDIR := $(OUTDIR)/man/html
MANHTML = $(MANSOURCES:$(MANDIR)/%.txt=$(MANHTMLDIR)/%.html)
@@ -353,13 +300,14 @@ manhtmlpages: man/apispec.txt $(MANHTML)

$(MANHTMLDIR)/%.html: CONFIG=config/manpages.conf

$(MANHTMLDIR)/%.html: $(MANDIR)/%.txt $(MANCOPYRIGHT) config/manpages.conf $(GENINCLUDE) $(GENDEPENDS)
$(MANHTMLDIR)/%.html: $(MANDIR)/%.txt $(MANCOPYRIGHT) config/manpages.conf $(GENINCLUDE) $(GENDEPENDS) katexinst
$(QUIET)$(MKDIR) $(MANHTMLDIR)
$(QUIET)$(ASCIIDOC) -b html5 -d manpage $(ADOCOPTS) \
-a themedir=$(CURDIR)/config -a theme=vkman \
-a katexpath=../../katex \
-o $@ -a svgpdf=$(SVGTYPEHTML) $<

# These targets are HTML and PDF single-file versions of the ref pages
# These targets are HTML5 and PDF single-file versions of the ref pages

manpdf: $(OUTDIR)/apispec.pdf

@@ -376,9 +324,10 @@ $(OUTDIR)/apispec.pdf: $(CONFIG) $(SPECVERSION) man/apispec.txt $(MANSOURCES) $(
-o $(OUTDIR) $(OUTDIR)/apispec.xml
$(QUIET)$(RM) $(OUTDIR)/apispec.xml

$(OUTDIR)/apispec.html: $(CONFIG) $(SPECVERSION) man/apispec.txt $(MANSOURCES) $(MANCOPYRIGHT) $(SVGFILES) $(GENINCLUDE) $(GENDEPENDS)
$(OUTDIR)/apispec.html: $(CONFIG) $(SPECVERSION) man/apispec.txt $(MANSOURCES) $(MANCOPYRIGHT) $(SVGFILES) $(GENINCLUDE) $(GENDEPENDS) katexinst
$(QUIET)$(MKDIR) $(OUTDIR)
$(QUIET)$(ASCIIDOC) -b html5 -d book $(ADOCOPTS) \
-a katexpath=katex \
-a themedir=$(CURDIR)/config -a theme=vkspec-xhtml \
-o $@ -a svgpdf=$(SVGTYPEHTML) man/apispec.txt

0 comments on commit ca4abe0

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