有關 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
中的依賴項根據需要建構的。