Vulkan Docs

Проект документации Vulkan ^® и Vulkan ^® SC API

Документацию по API ^Vulkan® см. в READMEVK.adoc.

Документацию по Vulkan ^® SC API см. в READMESC.adoc.

Структура каталогов

Структура каталогов следующая:

 README.adoc           This file
READMESC.adoc         Readme for the Vulkan SC specification
READMEVK.adoc         Readme for the Vulkan specification
BUILD.adoc            Documents how to build the specifications and reference pages
CONTRIBUTING.adoc     Requirements for external contributions to the repository
COPYING.adoc          Copyright and licensing information
CODE_OF_CONDUCT.adoc  Code of Conduct
LICENSE.adoc          Summary of licenses used by files in the repository
ChangeLog.adoc        Change log summary for each public Vulkan spec update
ChangeLogSC.adoc      Change log summary for each public Vulkan SC spec update
Makefile, make*       Makefile and helper build scripts (see BUILD.adoc)
antora/               Staging area for the docs.vulkan.org Antora 'proposals' and 'spec' modules
appendices/           Specification appendices
chapters/             Specification chapters
proposals/            Design documents for extensions
config/               Asciidoctor configuration, CSS, and index generator
images/               Images (figures, diagrams, icons)
gen/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`) as well as XML for non-Vulkan
                      data structures used with Video extensions (`video.xml`)
registry.adoc         Source for documentation of the XML format 

Создание спецификаций и справочных страниц

Источники документов размечаются в формате Asciidoctor, и мы используем asciidoctor и связанные с ним компоненты набора инструментов для создания выходных документов. См. BUILD.adoc для получения дополнительной информации об установке набора инструментов и создании спецификации.

Генерация заголовков и связанных файлов

См. xml/README.adoc.

Файлы заголовков ( include/vulkan/vulkan*.h ) и многие части документов спецификаций и справочных страниц генерируются на основе описаний в реестре XML API ( xml/vk.xml ). Сгенерированные файлы не возвращаются в репозиторий. Если вы измените vk.xml , вы можете восстановить заголовки, зайдя в xml/ и выполнив:

 $ сделать чистую установку

Остальные сгенерированные файлы собираются по мере необходимости с помощью зависимостей в Makefile верхнего уровня.