للحصول على الوثائق الخاصة بـ 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 Registry ( xml/vk.xml ). لا يتم فحص الملفات التي تم إنشاؤها في المستودع. إذا قمت بتغيير vk.xml ، فيمكنك إعادة إنشاء الرؤوس بالانتقال إلى xml/ وتشغيل:
$ إجراء التثبيت النظيف
يتم إنشاء الملفات الأخرى التي تم إنشاؤها حسب الحاجة عبر التبعيات في Makefile ذي المستوى الأعلى.
