Vulkan Docs

Proyecto de Documentación API ^Vulkan® y ^Vulkan® SC

Para obtener documentación específica de la API de Vulkan ^®, consulte READMEVK.adoc

Para obtener documentación específica de la API de ^Vulkan® SC, consulte READMESC.adoc

Estructura del directorio

La estructura del directorio es la siguiente:

 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 

Creación de las páginas de especificaciones y referencia

Las fuentes de los documentos están marcadas en formato Asciidoctor y utilizamos asciidoctor y componentes de la cadena de herramientas relacionados para generar documentos de salida. Consulte BUILD.adoc para obtener más información sobre cómo instalar la cadena de herramientas y crear la especificación.

Generando encabezados y archivos relacionados

Consulte xml/README.adoc.

Los archivos de encabezado ( include/vulkan/vulkan*.h ) y muchas partes de los documentos de la página de referencia y especificación se generan a partir de descripciones en el Registro API XML ( xml/vk.xml ). Los archivos generados no se registran en el repositorio. Si cambia vk.xml , puede regenerar los encabezados ingresando a xml/ y ejecutando:

 $ hacer una instalación limpia

Los otros archivos generados se crean según sea necesario a través de dependencias en el Makefile de nivel superior.