mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 04:25:12 +00:00
c5261decf6
* Update release number to 123.
Github Issues:
* Add missing aspect mask descriptions to elink:VkImageAspectFlagBits
(public pull request 1029).
* Modify validity generator script to not check validity of ignored values
in same-parent valid usage statements (public pull request 1030).
* Make slink:VkDescriptorUpdateTemplateCreateInfo::pname:descriptorSetLayout
`noautovalidity` in `vk.xml` (public pull request 1031).
* Fix footnote markup in the <<vkGetDeviceProcAddr behavior>> table
(public pull request 1034).
Internal Issues:
* Require that <<interfaces-builtin-variables-sgs, code:SubgroupSize>> be
a power of two (internal issue 1499).
* Clarify that shaderFloat64 and shaderInt64 enable all storage classes,
while shaderFloat16, shaderInt8, and shaderInt16 only enable
non-interface storage classes. in the <<features-shaderFloat64>>,
<<features-shaderInt64>>, and <<features-shaderInt16>> descriptions and
for slink:VkPhysicalDeviceShaderFloat16Int8FeaturesKHR (internal issue
1582).
* Fix broken asciidoctor conditional logic in the
<<spirvenv-module-validation, Validation Rules within a Module>>
section, and add style guide language to help avoid this problem in the
future (internal issue 1808).
* Modify VUID assignment script to use the first API include in a block as
part of the VUID name rather than the last one, so the VUID is based on
the promoted API name (internal issue 1809).
* Cleanup string descriptions to consistently refer to "`null-terminated
UTF-8`" strings (internal issue 1813).
* Clarify the purpose of the
slink:VkPhysicalDeviceLimits::ptext:maxDescriptorSet* limits (internal
merge request 3357).
* Fix the slink:VkPhysicalDeviceRayTracingPropertiesNV limits for
pname:maxGeometryCount, pname:maxInstanceCount, and
pname:maxTriangleCount in the <<limits-required, Required Limits>>
section (internal issue 3372).
* Update SPIR-V image op sign-matching rules in the
<<spirvenv-module-validation, Validation Rules within a Module>>
section, the <<formats-numericformat>> table, and the
<<interfaces-resources-descset, Descriptor Set Interface>> section
(internal spirv/SPIR-V issue 332).
New Extensions
* `<<VK_KHR_shader_subgroup_extended_types>>`
* `<<VK_GOOGLE_user_type>>`
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`.