Vulkan Docs

Proyek Dokumentasi Vulkan ^® dan Vulkan ^® SC API

Untuk dokumentasi khusus Vulkan ^® API, lihat READMEVK.adoc

Untuk dokumentasi khusus Vulkan ^® SC API, lihat READMESC.adoc

Struktur Direktori

Struktur direktorinya adalah sebagai berikut:

 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 

Membangun Halaman Spesifikasi dan Referensi

Sumber dokumen ditandai dalam format Asciidoctor, dan kami menggunakan asciidoctor dan komponen rantai alat terkait untuk menghasilkan dokumen keluaran. Lihat BUILD.adoc untuk informasi lebih lanjut tentang pemasangan rantai alat dan pembuatan Spesifikasi.

Menghasilkan Header dan File Terkait

Lihat xml/README.adoc.

File header ( include/vulkan/vulkan*.h ) dan banyak bagian dokumen halaman spesifikasi dan referensi dihasilkan dari deskripsi di XML API Registry ( xml/vk.xml ). File yang dihasilkan tidak diperiksa ke dalam repositori. Jika Anda mengubah vk.xml , Anda dapat membuat ulang header dengan masuk ke xml/ dan menjalankan:

 $ buat instalasi bersih

File lain yang dihasilkan dibuat sesuai kebutuhan melalui dependensi di Makefile tingkat atas.