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
의 종속성을 통해 빌드됩니다.