Vulkan-Docs/doc/specs/vulkan/config
Jon Leech b7b1c3a65d Change log for January 5, 2018 Vulkan 1.0.67 spec update:
* Bump API patch number and header version number to 67 for this update.
  * Update copyright dates to 2018

Github Issues:

  * Fix texture lookup functions in `GL_KHR_vulkan_glsl` specification
    (public pull request 363).
  * Clarify the state waited semaphores are left in when a call to
    flink:vkQueuePresentKHR fails (public issue 572).
  * Cleanup descriptions of slink:VkObjectTablePushConstantEntryNVX and
    slink:VkObjectTableDescriptorSetEntryNVX (public issue 583)
  * Remove redundant flink:vkCmdSetDiscardRectangleEXT valid usage
    statements (public pull 586).
  * Make dynamic state array length valid usage statements implicit for
    flink:vkCmdSetViewportWScalingNV, flink:vkCmdSetDiscardRectangleEXT, and
    flink:vkCmdSetViewport (public pull 589).
  * Clarify meaning of window extent (0,0) in slink:VkSwapchainKHR for the
    Windows and X11 platforms, in their respective extensions (public issue
    590).
  * Allow flink:vkGetPastPresentationTimingGOOGLE to return
    ename:VK_INCOMPLETE (public issue 604).
  * Add synchronization valid usage statements to flink:vkAcquireNextImage
    (public pull 611).
  * Fix some broken external links and internal xrefs (public pull 613).
  * Clean up slink:VkViewport valid usage statements in the presence or
    absence of relevant extensions (public pull 623).
  * Remove
    ename:VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR
    token from VK_KHR_maintenance2 from the non-extension VU path for
    slink:VkGraphicsPipelineCreateInfo (public issue 628).
  * Miscellaneous minor markup fixes - extension name strings (public pull
    631), Notes (pull 633), queue names emitted by generator scripts (pull
    634), block formatting in slink:VkDescriptorUpdateTemplateEntryKHR (pull
    635), ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG (pull
    641), quotes and apostrophes (pull 643),
  * Miscellaneous minor grammar fixes (public pull 644).
  * Fix markup macros so usage like ptext:*Src* works (public pull 647).

Internal Issues:

  * Clarify in the `VK_KHR_surface` and `VK_KHR_swapchain` extensions that
    parameter combinations which aren't supported for normal images are also
    unsupported for presentable images, even if the parameter values are
    individually supported as reported by the surface capability queries
    (internal issue 1029).
  * Fixed XML typo in the valid value field of the pname:sType member of
    slink:VkPhysicalDeviceExternalMemoryHostPropertiesEXT (internal issue
    1100).

Other Issues:

  * Add memory semantics validity rules to the <<spirvenv-module-validation,
    Validation Rules within a Module>> section of the SPIR-V environment
    appendix, and specify that sequentiality consistency is not supported.
    This forbids certain cases like "`Load+Release`" that we don't expect to
    ever be meaningful.
  * Document mapping of OpenGL Shading Language barriers to SPIR-V scope and
    semantics in the `GL_KHR_vulkan_glsl` specification.

New Extensions:

  * `VK_EXT_conservative_rasterization`
2018-01-05 17:39:15 -08:00
..
extension-highlighter Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
katex_replace Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
themes Adding chapter name into the pdf page footer 2017-10-13 16:13:55 +02:00
vu-to-json Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
vulkan-macros Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
.gitignore Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
README.md Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
asciidoctor-mathematical-ext.rb Change log for June 24, 2017 Vulkan 1.0.53 spec update: 2017-06-26 19:32:10 -07:00
attribs.txt Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
extension-highlighter.rb Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
katex_replace.rb Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
makeSubmit.py Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
mathtest.txt Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
optimize-pdf Change log for February 27, 2017 Vulkan 1.0.42 spec update: 2017-02-26 22:54:26 -08:00
tilde_open_block.rb Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
vu-to-json.rb Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00
vulkan-macros.rb Change log for January 5, 2018 Vulkan 1.0.67 spec update: 2018-01-05 17:39:15 -08:00

README.md

Vulkan Asciidoc Configuration Files

Macros

The macros in vulkan-macros.rb and vulkan-macros/extension.rb are described in the "Vulkan Documentation and Extensions: Procedures and Conventions" document (see the styleguide).

Support for Math

Asciidoctor is customized to insert KaTeX <script> tags from math.js for HTML5, and properly pass through math which has \begin{}\/end{} delimiters instead of [].

For PDF builds, asciidoctor-mathematical is used to generate

math-docbook.conf is heavily conditionalized depending on whether the final output format (which should be described in the a2x-format variable) is pdf or not, since Docbook passes through math differently to dblatex vs. the XHTML stylesheets. This could be simplified now that we're only using Docbook for PDFs.