status-im
/
Vulkan-Docs
mirror of https://github.com/status-im/Vulkan-Docs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
The Vulkan API Specification and related tools
420 Commits 36 Branches 134 Tags 18 MiB
JavaScript 59.4%
Python 32.6%
CSS 3.1%
Ruby 2%
Makefile 1.1%
Other 1.7%
Go to file
Jon Leech 40ba6e9a44 Change log for May 13, 2019 Vulkan 1.1.108 spec update: 
* Update release number to 108.

Internal Issues:

  * Clarify that only external resources can be bound to external memory in
    valid usage statements for flink:vkBindBufferMemory,
    flink:vkBindImageMemory, slink:VkSparseMemoryBind, and
    slink:VkSparseImageMemoryBind (internal issue 1496).
  * Move all `vk.xml`requirements for
    flink:vkGetDeviceGroupSurfacePresentModes2EXT into
    `<<VK_EXT_full_screen_exclusive>>` (internal issue 1622).
  * Add some missing valid usage statements for
    flink:vkCmdEndQueryIndexedEXT (internal issue 1638).
  * Specify rules for defining "`New Flags and Bitmask Types`" in that
    section of the style guide (internal issue 1649).
  * Add a comment to the `vk.xml` extension block for
    `VK_ANDROID_native_buffer` explaining why the extension is tagged
    `"disabled"` (internal issue 1657).
  * Fix typos in the description of slink:VkImageViewCreateInfo (internal
    issue 1661).
  * Modify valid usage statements for slink:VkImageViewCreateInfo to fix the
    description about the restriction for pname:baseArrayLayer and
    pname:layerCount from pname:extent.depth to the depth of mipmap level
    while creating a 2D array image view on a 3D image.
  * Forbid structures that contain opaque types (images or samplers) in the
    SPIR-V <<spirvenv-module-validation, Validation Rules within a Module>>
    section.
  * Minor editorial changes for the `VK_EXT_swapchain_colorspace` extension
    in the description of slink:VkColorSpace KHR and `vk.xml`, including:
  ** Consistently specify which function (OETF or Inverse-EOTF) is being
     defined;
  ** Remove the Display P3 EOTF, since no other EOTFs are defined;
  ** Include luminance range for the HLG OETF;
  ** Remove a duplicated paragraph; and,
  ** Rename ename:VK_COLOR_SPACE_DISPLAY_P3_LINEAR_EXT, leaving the old
     ename:VK_COLOR_SPACE_DCI_P3_LINEAR_EXT token as an alias.

New Extensions:

  * `<<VK_NV_framebuffer_mixed_samples_coverage_reduction_mode>>`
  * `<<VK_KHR_uniform_buffer_standard_layout>>`
 		2019-05-13 01:49:34 -07:00
.gitlab/issue_templates Change log for November 4, 2018 Vulkan 1.1.91 spec update: 2018-11-03 23:50:13 -07:00
appendices Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
chapters Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
config Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19:43 -07:00
images Change log for March 18, 2019 Vulkan 1.1.104 spec update: 2019-03-17 06:05:46 -07:00
include/vulkan Change log for March 19, 2019 Vulkan 1.1.105 spec update (GDC edition): 2019-03-19 01:18:13 -07:00
katex Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
man Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
out Change log for March 5, 2018 Vulkan 1.1.72 spec update: 2018-04-05 04:24:56 -07:00
scripts Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
src/ext_loader Change log for May 25, 2018 Vulkan 1.1.76 spec update: 2018-05-25 04:00:32 -07:00
style Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
tests Change log for April 7, 2019 Vulkan 1.1.106 spec update: 2019-04-07 20:17:23 -07:00
xml Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
.gitattributes Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
.gitignore Change log for December 16, 2018 Vulkan 1.1.96 spec update: 2018-12-16 22:22:53 -08:00
.gitlab-ci.yml Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19:43 -07:00
BUILD.adoc Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19:43 -07:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2018-09-24 10:55:10 -04:00
COPYING.md Merge remote-tracking branch 'upstream/master' into typos 2018-11-04 17:46:20 +01:00
ChangeLog.txt Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
Makefile Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
README.adoc Change log for April 7, 2019 Vulkan 1.1.106 spec update: 2019-04-07 20:17:23 -07:00
copyright-ccby.txt Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
copyright-spec.txt Change log for March 18, 2019 Vulkan 1.1.104 spec update: 2019-03-17 06:05:46 -07:00
installRelease Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
makeAllExts Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
makeExt Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
makeKHR Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
refPageNotes.md Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
registry.txt Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
sandboxCopy Change log for March 5, 2018 Vulkan 1.1.72 spec update: 2018-04-05 04:24:56 -07:00
styleguide.txt Change log for May 13, 2019 Vulkan 1.1.108 spec update: 2019-05-13 01:49:34 -07:00
update_valid_usage_ids.sh Fix Makefile PATCHVERSION to 72, and finish cleaning up after the 2018-04-05 05:07:37 -07:00
vkspec.txt Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00

README.adoc 

ifdef::env-github[]
:note-caption: :information_source:
endif::[]

= Vulkan^(R)^ API Documentation Project

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

[options="compact"]
 * The Vulkan API Specification
 * Specification of Vulkan extensions
 * API reference ("`man`") pages
 * The XML API Registry (also mirrored at
   https://github.com/KhronosGroup/Vulkan-Headers)
 * Vulkan header files (also mirrored at
   https://github.com/KhronosGroup/Vulkan-Headers)
 * Related tools and scripts.

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 link:BUILD.adoc[BUILD.adoc] for more information on installing the
toolchain and building the Specification.


== Generating Headers and Related Files

See link:xml/README.adoc[xml/README.adoc].

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`.