e29a51b231
* Bump API patch number and header version number to 41 for this update. Github Issues: * Made all uses of `NULL` vs. code:VK_NULL_HANDLE consistent (public issue 276). * Clarify render pass compatibility in different usage scenarios (public issues 303 and 304). * Add valid usage statements to slink:VkFramebufferCreateInfo requiring that the width, height, and number of layers of the framebuffer all be nonzero (public issue 432). * Allow `offset` and `align` in any GLSL version for the `GL_KHR_vulkan_glsl` extension (public issue 435). * Specify lifetime of string objects passed to the tlink:PFN_vkDebugReportCallbackEXT user callback in the +VK_EXT_debug_report+ extension (public issue 446). * Fix inter-page links in multi-file reference pages (public issue 454). Internal Issues: * Update valid usage language for slink:VkImageCreateInfo to disallow creating images that have ename:VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set without other attachment usage bits (ename:VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT, ename:VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, or ename:VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) (internal issue 540). * Disable `VK_EXT_swapchain_colorspace` extension until internal issues 640 and 661 are mutually resolved. * Allow alternative mipmap level selection when [eq]#lambda == 0.5# during texture <<textures-image-level-selection,Image Level(s) Selection>> (internal issue 680). Other Issues: * Add a clarification to the style guide that the extension revision number is treated as a patch number, so that changes to published extensions should only include bug fixes and spec clarifications. |
||
---|---|---|
.. | ||
katex_replace | ||
vulkan-macros | ||
README.md | ||
asciidoctor-pdf-monkeypatch.rb | ||
attribs.txt | ||
extDependency.sh | ||
katex_replace.rb | ||
mathtest.txt | ||
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.