Vulkan ® API 固有のドキュメントについては、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の依存関係を介して必要に応じてビルドされます。
