ca4abe0d34
* 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.
2.2 KiB
Vulkan Asciidoc Configuration Files
Config File Macros
The macros in vkspec.conf and manpages.conf are described in the "Vulkan
Documentation and Extensions: Procedures and Conventions" document (see the
styleguide). There's a parsing issue with comments in
vkspec.conf, so they are pulled out here for now.
PDF Generation
vkspec-dblatex.xsl is XSL specific to a2x->dblatex->PDF spec generation.
It is a very slightly modified version of
/etc/asciidoc/dblatex/asciidoc-dblatex.xsl, as follows:
<xsl:param name="latex.hyperparam">colorlinks,linkcolor=black,pdfstartview=FitH</xsl:param>
<xsl:param name="doc.publisher.show">0</xsl:param>
<xsl:param name="latex.output.revhistory">0</xsl:param>
and has been simplified to just those parameters. Additional templates
replacing those under /usr/share/xml/docbook/stylesheet/dblatex/xsl/*
can be added here.
HTML Generation
vkspec-html.css is CSS for HTML generated by the asciidoc xhtml11 and
html5 backends. It is branched from /etc/asciidoc/stylesheets/asciidoc.css
and tweaked to more closely resemble the asciidoc Docbook XHTML stylesheet.
This gives us direct control over CSS for the document, including support
for markup styles.
Asciidoc Stylesheets
docbook-xsl/common.xsl replaces parts of the asciibook stylesheets
normally found under /etc/asciidoc/docbook-xsl in order to generate
consistent IDs on sections. We no longer support the docbook toolchain for
anything except PDF output, so other specializations have been removed.
Support for Math
math-asciidoc.conf, math-docbook.conf, and math.js customize asciidoc
macros for HTML5 and Docbook output to insert KaTeX <script> tags from
math.js for HTML5, and properly pass through math which has
\begin{}\/end{} delimiters instead of $$[], using the
<?texmath delimiters="user"?> processing instruction.
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.