有关 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
中的依赖项根据需要构建的。