Vulkan Docs herunterladen – Vulkan Docs Quellcode herunterladen

Vulkan Docs

Anderer Quellcode

Herunterladen

Vulkan ^® und Vulkan ^® SC API-Dokumentationsprojekt

Eine spezifische Dokumentation zur Vulkan® ^- API finden Sie unter READMEVK.adoc

Eine spezifische Dokumentation zur ^Vulkan® SC-API finden Sie unter READMESC.adoc

Verzeichnisstruktur

Die Verzeichnisstruktur ist wie folgt:

 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

Erstellen der Spezifikations- und Referenzseiten

Die Dokumentquellen werden im Asciidoctor-Format markiert, und wir verwenden asciidoctor und zugehörige Toolchain-Komponenten, um Ausgabedokumente zu generieren. Weitere Informationen zur Installation der Toolchain und zum Erstellen der Spezifikation finden Sie in BUILD.adoc.

Siehe xml/README.adoc.

Die Header-Dateien ( include/vulkan/vulkan*.h ) und viele Teile der Spezifikations- und Referenzseitendokumente werden aus Beschreibungen in der XML-API-Registrierung ( xml/vk.xml ) generiert. Die generierten Dateien werden nicht in das Repository eingecheckt. Wenn Sie vk.xml ändern, können Sie die Header neu generieren, indem Sie in xml/ gehen und Folgendes ausführen: