Skip to content
The Vulkan API Specification and related tools
JavaScript Python CSS Ruby Makefile Perl Other
Branch: master
Clone or download
oddhack Change log for October 13, 2019 Vulkan 1.1.125 spec update:
  * Update release number to 125.

Github Issues:

  * Allow slink:VkRenderPassFragmentDensityMapCreateInfoEXT to extend
    slink:VkRenderPassCreateInfo2KHR in `vk.xml` (public issue 1027).
  * Fix markup in `<<VK_EXT_external_memory_dma_buf>>` appendix (public pull
    request 1051).
  * Update .gitignore (public pull request 1052).

Internal Issues:

  * Disallowed slink:VkEvent from participating in queue family ownership
    transfers in the <<devsandqueues-index, Queue Family Index>> section
    (internal issue 1691).
  * Relax language describing default NT handle access rights for
    slink:VkExportMemoryWin32HandleInfoKHR and
    slink:VkExportSemaphoreWin32HandleInfoKHR (internal issue 1838).
  * Fix markup for slink:VkDeviceCreateInfo valid usage statement 00372 to
    remove imbedded asciidoctor conditionals by splitting it into two VUs
    (internal issue 1846).
  * Clarify lifetime of samplers used as immutable samplers in
    slink:VkDescriptorSetLayoutBinding (internal issue 1849).
  * Add a valid usage statement prohibiting flink:vkCmdBeginQuery on
    timestamp queries (internal issue 1851).
  * Correct some <<Precision of GLSL.std.450 Instructions, SPIR-V
    instruction precisions>> (internal merge request 3391).
  * Fix a typo in flink:vkQueueBindSparse valid usage statement 03245
    (internal merge request 3394).

New Extensions

  * `<<VK_KHR_spirv_1_4>>`
Latest commit a5b1077 Oct 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitlab/issue_templates Change log for August 25, 2019 Vulkan 1.1.121 spec update: Aug 25, 2019
appendices Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
chapters Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
config Change log for September 8, 2019 Vulkan 1.1.122 spec update: Sep 9, 2019
images Change log for July 28, 2019 Vulkan 1.1.117 spec update: Jul 29, 2019
include/vulkan Change log for March 19, 2019 Vulkan 1.1.105 spec update (GDC edition): Mar 19, 2019
katex Change log for February 3, 2019 Vulkan 1.1.99 spec update: Feb 4, 2019
man Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
out Change log for March 5, 2018 Vulkan 1.1.72 spec update: Apr 5, 2018
scripts Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
src/ext_loader Change log for May 25, 2018 Vulkan 1.1.76 spec update: May 25, 2018
style Change log for September 15, 2019 Vulkan 1.1.123 spec update: Sep 15, 2019
tests Change log for April 7, 2019 Vulkan 1.1.106 spec update: Apr 8, 2019
xml Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
.gitattributes Restructure the repository to put the specification Makefile and Apr 5, 2018
.gitignore Update gitignore (#1052) Oct 13, 2019
.gitlab-ci.yml Change log for August 17, 2019 Vulkan 1.1.120 spec update: Aug 17, 2019
BUILD.adoc Change log for August 11, 2019 Vulkan 1.1.118 spec update: Aug 11, 2019
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md Sep 24, 2018
COPYING.md Merge remote-tracking branch 'upstream/master' into typos Nov 4, 2018
ChangeLog.txt Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
Makefile Change log for October 13, 2019 Vulkan 1.1.125 spec update: Oct 14, 2019
README.adoc Change log for April 7, 2019 Vulkan 1.1.106 spec update: Apr 8, 2019
copyright-ccby.txt Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
copyright-spec.txt Change log for March 18, 2019 Vulkan 1.1.104 spec update: Mar 17, 2019
gen-script-docs.sh Change log for September 8, 2019 Vulkan 1.1.122 spec update: Sep 9, 2019
installRelease Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
makeAllExts Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
makeExt Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
makeKHR Change log for January 05, 2019 Vulkan 1.1.97 spec update: Jan 6, 2019
refPageNotes.md Restructure the repository to put the specification Makefile and Apr 5, 2018
registry.txt Change log for August 25, 2019 Vulkan 1.1.121 spec update: Aug 25, 2019
sandboxCopy Change log for March 5, 2018 Vulkan 1.1.72 spec update: Apr 5, 2018
styleguide.txt Update gitignore (#1052) Oct 13, 2019
update_valid_usage_ids.sh Fix Makefile PATCHVERSION to 72, and finish cleaning up after the Apr 5, 2018
vkspec.txt Change log for March 3, 2019 Vulkan 1.1.102 spec update: Mar 4, 2019

README.adoc

Vulkan® API Documentation Project

This repository contains sources for the formal documentation of the Vulkan API. This includes:

The authoritative public repository is located at https://github.com/KhronosGroup/Vulkan-Docs/. It hosts a public Issue tracker, and outside developers can file proposed patches (Pull Requests) against the Specification, subject to approval by Khronos.

If in doubt where to submit your Issue, consult the https://github.com/KhronosGroup/Vulkan-Ecosystem repo.

Branch Structure

Everything is now maintained in the master branch of the repository. From this branch it is possible to generate both Vulkan 1.1 and Vulkan 1.0 Specifications, as well as specifications for any set of Extensions.

Directory Structure

The directory structure is as follows:

README.adoc           This file
BUILD.adoc            Documents how to build the specifications, and man pages
COPYING.md            Copyright and licensing information
CODE_OF_CONDUCT.md    Code of Conduct
ChangeLog.txt         Change log summary for each public spec update
Makefile, make*       Makefile and helper build scripts (see BUILD.adoc)
appendices/           Specification appendices
chapters/             Specification chapters
config/               Asciidoctor configuration, CSS, and index generator
images/               Images (figures, diagrams, icons)
man/                  Reference (man) pages for the API; mostly extracted from the spec source
out/                  Default directory for the generated documents
scripts/              Helper scripts used in specification, header, and reference page generation
style/                Sources for "styleguide" (Vulkan Documentation and Extensions: Procedures and Conventions)
xml/                  XML API Registry (vk.xml)
registry.txt          Sources for documentation of the vk.xml format

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.

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 are not checked into the repository. If you change vk.xml, you can regenerate the headers by going into xml/ and running:

$ make clean install

The other generated files are built as required via dependencies in the top-level Makefile.

You can’t perform that action at this time.