476e3f422d
* Update release number to 104. Public Issues: * Remove the incorrect line from "`Initial`" to "`Invalid`" state in the <<commandbuffer-lifecycle-diagram, Lifecycle of a command buffer>> diagram (public issue 881). * Add Fuchsia platform to <<boilerplate-wsi-header-table, Window System Extensions and Headers>> table (public pull request 933). * Change the type of slink:VkBufferDeviceAddressCreateInfoEXT::pname:deviceAddress from basetype:VkDeviceSize to basetype:VkDeviceAddress. These are both typedefs of code:uint64_t, so it is an ABI-compatible change (public issue 934). Internal Issues: * Remove generated header files and update the CI tests to build a copy of the headers for use by the hpp-generate / hpp-compile CI stages. Targets to generate the headers will not be removed, but keeping these generated files in the repository increased the frequency of conflicts between branches when merging to master (internal issue 745). * Reword "`undefined: behavior if *action*" to "`must: not do *action*`" in the places the old terminology was used, and add a new <<writing-undefined, Describing Undefined Behavior>> section of the style guide to explain how to write such language in the future (internal issue 1579). * Move almost all Python scripts into the toplevel `scripts/` directory. Apply extensive internal edits to clean up and simplify the scripts, and try to follow PEP8 guidelines. Generalize the scripts with the use of a Conventions object controlling many aspects of output generation, to enable their use in other Khronos projects with similar requirements. Autogenerate extension interface refpages (these are experimental and may be retired going forward). New Extensions: * `VK_AMD_display_native_hdr` * `VK_EXT_full_screen_exclusive` (internal issue 1439) * `VK_EXT_host_query_reset` * `VK_EXT_pipeline_creation_feedback` (internal issue 1560) * `VK_KHR_surface_protected_capabilities` (internal issue 1520) |
||
---|---|---|
.. | ||
extension-highlighter | ||
katex_replace | ||
themes | ||
vu-to-json | ||
vulkan-macros | ||
.gitignore | ||
README.md | ||
asciidoctor-mathematical-ext.rb | ||
attribs.txt | ||
extension-highlighter.rb | ||
katex_replace.rb | ||
khronos.css | ||
makeSubmit.py | ||
mathtest.txt | ||
optimize-pdf | ||
tilde_open_block.rb | ||
vu-to-json.rb | ||
vulkan-macros.rb |
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.
Stylesheets
khronos.css
is the stylesheet used for HTML output.