Téléchargement de Vulkan Docs - Téléchargement du code source Vulkan Docs

Vulkan Docs

Autre code source

Télécharger

Projet de documentation des API Vulkan ^® et Vulkan ^® SC

Pour la documentation spécifique à l'API Vulkan ^® , voir READMEVK.adoc

Pour la documentation spécifique à l'API Vulkan ^® SC, voir READMESC.adoc

Structure du répertoire

La structure des répertoires est la suivante :

 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

Création des pages de spécifications et de référence

Les sources des documents sont balisées au format Asciidoctor, et nous utilisons asciidoctor et les composants de la chaîne d'outils associés pour générer des documents de sortie. Voir BUILD.adoc pour plus d'informations sur l'installation de la chaîne d'outils et la création de la spécification.

Voir xml/README.adoc.

Les fichiers d'en-tête ( include/vulkan/vulkan*.h ) et de nombreuses parties des documents de spécification et de page de référence sont générés à partir des descriptions du registre de l'API XML ( xml/vk.xml ). Les fichiers générés ne sont pas archivés dans le référentiel. Si vous modifiez vk.xml , vous pouvez régénérer les en-têtes en allant dans xml/ et en exécutant :