1ca0ea1ef0
* Bump API patch number and header version number to 22 for this update.
Github Issues:
* Translate the subpass self-dependency language into concrete
validity statements, and added a validity statement about the
restrictions on layout parameters (public issue 267).
* Add validity requirement that
slink:VkAttachmentDescription::pname:finalLayout and
slink:VkAttachmentReference::pname:layout must not be
ename:VK_IMAGE_LAYOUT_UNDEFINED or
ename:VK_IMAGE_LAYOUT_PREINITIALIZED (public issue 268).
* Clarify that slink:VkSubpassDescription::pname:pResolveAttachments
layouts are used. Make language consistent with other attachment
arrays (public issue 270).
* Changed 64-bit definition for
dname:VK_DEFINE_NON_DISPATCHABLE_HANDLE to work for x32 platform in
+vk.xml+ and the resulting +vulkan.h+ (public issue 282).
* Add missing error return code for
flink:vkEnumerateInstanceExtensionProperties and
flink:vkEnumerateDeviceExtensionProperties (public issue 285)
* Fix several cases of stext::VkStructName.memberName markup to
stext::VkStructName::pname:memberName, to match other usage in the
spec, and describe this markup in the style guide (public issue
286).
* Modified validity language generation script to avoid redundant
common ancestor language if covered by generic parent language, and
used `Both' instead of `Each' when appropriate (public issue 288).
Internal Issues:
* Add language about behavior of flink:vkAllocateDescriptorSets when
allocation fails due to fragmentation, a new error
ename:VK_ERROR_FRAGMENTED_POOL, and a Note explaining the situation
(internal issue 309).
* For the features of code:PointSize, code:ClipDistance, and
code:CullDistance, the SPIR-V capability is required to be declared
on use (read or write) rather than on decoration (internal issue
359).
* Have desktop versions of GLSL respect precision qualification
(code:mediump and code:lowp) when compiling for Vulkan. These will
get translated to SPIR-V's code:RelaxedPrecision decoration as they
do with OpenGL ES versions of GLSL (ESSL). The default precision of
all types is code:highp when using a desktop version (internal issue
360).
* Add validity statement for slink:VkImageCreateInfo specifying that
multisampled images must be two-dimensional, optimally tiled, and
with a single mipmap level (internal issue 369).
* Add validity statements to slink:VkImageViewCreateInfo disallowing
creation of images or image views with no supported features. Made
some slink:VkImageViewCreateInfo validity statements more precise
and consistent. Added a Note to the <<features,features>> chapter
about formats with no features (internal issue 371).
* Remove +manpages+ from default build targets. Nroff outputs
containing imbedded latexmath will not render properly. Fixing this
is a lot of work for limited use cases (internal issue 401).
Other Commits:
* Fix flink:vkRenderPassBeginInfo::pname:clearValueCount validity
statement to be based on attachment indices rather than the number
of cleared attachments
(Vulkan-LoaderAndValidationLayers/issues/601).
* Convert registry documentation from LaTeX to asciidoc source and
rename from +src/spec/readme.tex+ to +src/spec/registry.txt+.
* Fix lack of Oxford commas in validity language.
* Lots of cleanup of generator scripts and Makefiles to move extension
list for generator into the script arguments instead of the body of
genvk.py, and express better dependencies between XML, scripts, and
generated files.
|
||
|---|---|---|
| .. | ||
| 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.