Vulkan Docs

Projeto de documentação da API Vulkan ^® e Vulkan ^® SC

Para documentação específica da API Vulkan ^® , consulte READMEVK.adoc

Para documentação específica da API Vulkan ^® SC, consulte READMESC.adoc

Estrutura de diretório

A estrutura do diretório é a seguinte:

 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 

Construindo as páginas de especificação e referência

As fontes dos documentos são marcadas no formato Asciidoctor e usamos asciidoctor e componentes do conjunto de ferramentas relacionados para gerar documentos de saída. Consulte BUILD.adoc para obter mais informações sobre como instalar a cadeia de ferramentas e construir a Especificação.

Gerando cabeçalhos e arquivos relacionados

Consulte xml/README.adoc.

Os arquivos de cabeçalho ( include/vulkan/vulkan*.h ) e muitas partes da especificação e dos documentos da página de referência são gerados a partir de descrições no XML API Registry ( xml/vk.xml ). Os arquivos gerados não são verificados no repositório. Se você alterar vk.xml , poderá regenerar os cabeçalhos entrando em xml/ e executando:

 $ faça uma instalação limpa

Os outros arquivos gerados são construídos conforme necessário por meio de dependências no Makefile de nível superior.