eaea7d2709
* Bump API patch number and header version number to 26 for this update.
Github Issues:
* Bring sample code in the +VK_KHR_surface+ and +VK_KHR_swapchain+
extension summary appendices up to date, and note they will be replaced
with pointers to the LunarG SDK examples in the future (public issue
279).
* Add a new <<fundamentals-commandsyntax-results-lifetime,Lifetime of
Retrieved Results>> section specifying that ftext:vkGet* and
ftext:VkEnumerate* results are invariant unless otherwise specified, and
specify behavior for individual commands which are not invariant (public
issue 280).
* Remove conflicting definition of
slink:VkDisplayPlaneCapabilitiesKHR::pname:maxSrcPosition and clean up
language of the remaining definition (public issue 351).
* Fix many minor spelling errors and add rules to the style guide to
prevent recurrences (public issue 352).
Internal Issues:
* Remove redundant descriptions of the etext:VK_USE_PLATFORM_* macros from
the <<wsi,Window System Integration>> chapter in favor of the
description in the <<boilerplate-wsi-header,Window System-Specific
Header Control>> appendix (internal issue 6).
* Replace misleading 'can: be destroyed when not X' with more correct
'must: not be destroyed while X' in the
<<fundamentals-objectmodel-lifetime,Object Lifetime>> section. Disallow
destroying a pipeline layout while a command buffer using it is
recording (internal issue 241).
* Clarify that ename:VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT is valid for
all images used as attachments in elink:VkImageUsageFlagBits and the
slink:VkImageLayout validity language (internal issue 320).
* Note that <<extended-functionality-layers,Layers>> may wrap object
handles, but that this is a generally discouraged. A link to additional
information in the documentation for layer authors is provided (issue
398)
* Replace the mustnot: and shouldnot: macros with equivalent must: not and
should: not to get rid of non-English words while still highlighting
normative language (internal issue 407).
* Disallow creating multisampled images with
ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT in the slink:VkImageLayout
validity language and the <<features-supported-sample-counts,Supported
Sample Counts>> section (internal issue 445).
* Fix typo so that flink:vkCmdDrawIndexedIndirect is defined in terms of
flink:vkCmdDrawIndexed rather than flink:vkCmdDrawIndirect (internal
issue 446).
* Reorganize the per-extension information sections to all be in the
<<extensions,Layers & Extensions>> appendix. Also fix a typo in
+VK_IMG_filter_cubic+ which incorrectly identified it as a +KHR+
extension (internal issue 461).
Other Issues:
* Use asciidoc markup instead of latexmath to simplify diagrams in the
<<features-formats-non-packed,byte mapping tables>> for color formats.
* Fix a markup problem with the wildcarded enumerant names in a NOTE in
the <<textures-texel-replacement,Texel Replacement>> section.
* Fix missing attributes in the XML interface for
elink:VkExternalMemoryHandleTypeFlagBitsNV and
elink:VkExternalMemoryFeatureFlagBitsNV (KhronosGroup/Vulkan-Hpp issue
#25)
* Cleanup reference page builds so only core pages are built for releases.
|
||
|---|---|---|
| .. | ||
| docbook-xsl | ||
| README | ||
| manpages.conf | ||
| mathjax-asciidoc.conf | ||
| mathjax-docbook.conf | ||
| mathjax.js | ||
| vkman.css | ||
| vkspec-dblatex.sty | ||
| vkspec-dblatex.xsl | ||
| vkspec-xhtml.css | ||
| vkspec.conf | ||
README
This gives an overview of the configuration files in this directory
(doc/specs/vulkan/config/).
--------------- Config File Macros ----------------
The macros in vkspec.conf and manpages.conf are described in the Vulkan
Documentation and Extensions: Procedures and Conventions document (see
../styleguide.txt). 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.
---------------- XHTML Generation -----------------
vkspec-xhtml.css
is CSS for the xhtml and chunked targets. It is pulled in from
docbook-xsl/common.xsl. This gives us direct control over the CSS for
the document, including support for markup styles.
-------------- Asciibook Stylesheets --------------
docbook-xsl/chunked.xsl
docbook-xsl/common.xsl
docbook-xsl/xhtml.xsl
docbook-xsl/manpage.xsl
replace parts of the asciibook stylesheets normally found under
/etc/asciidoc/docbook-xsl , in order to generate consistent IDs on
sections and to insert MathJax <script> tags into HTML headers. More
will be required for other output types.
---------------- Support for Math -----------------
mathjax-asciidoc.conf
mathjax-docbook.conf
mathjax.js
customize asciidoc macros for HTML and Docbook output to insert MathJax
<script> tags from mathjax.js, and properly pass through math which has
\begin{}\/end{} delimiters instead of $$\[\]\(\), using the <?texmath
delimiters="user"?> processing instruction.
mathjax-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 HTML stylesheets.