ff9357a4ba
* Update release number to 79.
Public Issues:
* Add a note to the <<features-required-format-support, Required Format
Support>> section clarifying that the required formats don't depend on
the used flags (public issue 671).
* Add a valid usage statement for flink:vkUpdateDescriptors that was
previously described for slink:VkImageSubresourceRange, but not as a
valid usage statement (public issue 713).
* Modify implicit valid usage generator script to not emit 'must: not be
0' for a parameter that is a pointer to a flags field, such as
pname:pPeerMemoryFeatures (public issue 729).
Internal Issues:
* Add definitions of "`obsoleted`" and "`deprecated`", and modify the
definition of "`promoted`" in the <<glossary, Glossary>> (internal issue
988).
* Add language for integer texel output conversions (the conversion is
undefined) to the <<textures-output-format-conversion]] Texel Output
Format Conversion>> section. Simplify and clarify the floating-point
conversion language in the <<fundamentals-general, General
Requirements>> section and the new <<fundamentals-fp-conversion,
Floating-Point Format Conversions>> section, and remove obsolete
language in the format-specific floating-point sections (internal issue
1275).
* Add the elink:VkVendorId enumerated type to the Vulkan API / XML /
header, so reserved Khronos vendor IDs can be referred to symbolically
by clients. Note that only Khronos vendor IDs (e.g. non-PCI vendor IDs)
are defined (internal issue 1299).
* Fix typo in the <<fig-non-strict-lines, Non strict lines>> table
(internal issue 1315).
* Clean up and simplify the
<<features-formats-requiring-sampler-ycbcr-conversion, YCbCr format
properties>> table and use symbols consistently with other tables. Add a
column for the number of planes.
* Add code:Float16 to the <<spirvenv-capabilities-table, List of optional
SPIR-V capabilities>> for the `VK_AMD_gpu_shader_half_float` extension.
|
||
|---|---|---|
| appendices | ||
| chapters | ||
| config | ||
| images | ||
| include/vulkan | ||
| katex | ||
| man | ||
| out | ||
| scripts | ||
| src/ext_loader | ||
| style | ||
| xml | ||
| .gitattributes | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| BUILD.adoc | ||
| COPYING.md | ||
| ChangeLog.txt | ||
| Makefile | ||
| README.adoc | ||
| checkLinks.py | ||
| copyright-ccby.txt | ||
| copyright-spec.txt | ||
| fixupRef.py | ||
| genRef.py | ||
| genRelease | ||
| genspec.py | ||
| installRelease | ||
| makeAllExts | ||
| makeExt | ||
| makeKHR | ||
| promote.py | ||
| refDesc.py | ||
| refPageNotes.md | ||
| reflib.py | ||
| reflow.py | ||
| reflow_count.py | ||
| registry.txt | ||
| sandboxCopy | ||
| styleguide.txt | ||
| update_valid_usage_ids.sh | ||
| vkspec.txt | ||
README.adoc
= Vulkan^(R)^ API Documentation Project
This repository contains formal documentation of the Vulkan API. This
includes the Specification of the Vulkan API, including extensions; the
reference ("`man`") pages; the XML API Registry; header files; and related
tools and scripts.
The authoritative public repository is located at
https://github.com/KhronosGroup/Vulkan-Docs/ . Issues, proposed fixes for
issues, and other suggested changes should be created using Github.
== Branch Structure
With the release of Vulkan 1.1, the current Specification is now maintained
in the `master` branch of the repository. It is possible to generate both
Vulkan 1.1 and Vulkan 1.0 Specifications from this branch.
=== `1.0` Branch Is Obsolete
The `1.0` branch in which the 1.0 Specification was previously maintained is
now obsolete. The `1.0` branch will not be updated going forward, and all
outstanding pull requests or merge requests against the `1.0` branch must be
rebased on, and retargeted to `master`.
== Directory Structure
The directory structure was changed following the 1.1.70 spec update to move
the specification directory to the root of the repository, and move other
content relative to that. There may be additional cleanup and simplification
in the future.
```
README.adoc This file
BUILD.adoc Build targets and methods for the specification
ChangeLog.txt Change log summary for each public spec update
appendices/ Specification appendices
chapters/ Specification chapters
config/ asciidoc configuration
images/ Images (figures, diagrams, icons)
include/vulkan/ Vulkan headers, generated from the Registry
man/ Reference (manual) pages for API, mostly extracted from the spec source
xml/ XML API Registry (vk.xml) and related scripts
src/ext_loader/ Extension loader library
```
== Building the Specification and Reference Pages
The document sources are marked up in `asciidoctor` format, and we use
asciidoctor and related toolchain components to generate output documents.
See `BUILD.adoc` for more information on installing the toolchain and
building the Specification.
== Generating Headers and Related Files
The header files (`include/vulkan/vulkan*.h`) and many parts of the
specification and reference page documents are generated from descriptions
in the XML API Registry (`xml/vk.xml`). The generated files, with the
exception of header files, are not checked into the repository. If you
change `vk.xml`, you can regenerate the header by going to `xml/` and
running:
$ make clean install
The other generated files are built as required via dependencies in
the top-level `Makefile`.