GitHubじゃ!Pythonじゃ!

GitHubからPython関係の優良リポジトリを探したかったのじゃー、でも英語は出来ないから日本語で読むのじゃー、英語社会世知辛いのじゃー

KhronosGroup

Vulkan-Docs – Vulkan API仕様および関連ツール

投稿日:

Vulkan API仕様および関連ツール

Vulkan APIドキュメントプロジェクト

このリポジトリには、Vulkan APIの正式なドキュメントが含まれています。 これには、拡張機能を含むVulkan APIの仕様が含まれます。 参照( “man”)ページ。 XML APIレジストリ。 ヘッダーファイル。 および関連するツールとスクリプト。

権限のある公開リポジトリはhttps://github.com/KhronosGroup/Vulkan-Docs/にあります 問題、問題の修正案、およびその他の変更案は、Githubを使用して作成する必要があります。

分岐構造

Vulkan 1.1のリリースでは、現在の仕様がリポジトリのmasterブランチで管理されるようになりました。 このブランチからVulkan 1.1とVulkan 1.0の両方の仕様を生成することが可能です。

1.0ブランチは廃止されました

1.0仕様が以前に維持されていた1.0ブランチは現在廃止されています。 1.0ブランチは今後更新されず、 1.0ブランチに対する未処理のプル要求またはマージ要求はすべてリベースされ、 masterリターゲットされなければなりません。

ディレクトリ構造

リポジトリのルートに指定ディレクトリを移動し、それに関連して他のコンテンツを移動するために、1.1.70仕様更新に続いてディレクトリ構造が変更されました。 今後、クリーンアップと簡素化が追加される可能性があります。

README.adoc             This file
BUILD.adoc              Build targets and methods for the specification
ChangeLog.txt           Change log summary for each public spec update
appendices/             Specification appendices
chapters/               Specification chapters
config/                 asciidoc configuration
images/                 Images (figures, diagrams, icons)
include/vulkan/         Vulkan headers, generated from the Registry
man/                    Reference (manual) pages for API, mostly extracted from the spec source
xml/                    XML API Registry (vk.xml) and related scripts
src/ext_loader/         Extension loader library

仕様とリファレンスページの作成

ドキュメントソースはasciidoctor形式でマークアップされ、asciidoctorと関連ツールチェーンコンポーネントを使用して出力ドキュメントを生成します。 ツールチェーンのインストールと仕様の構築の詳細については、 BUILD.adocを参照してください。

ヘッダーと関連ファイルの生成

ヘッダーファイル( include/vulkan/vulkan*.h )と仕様書とリファレンスページの多くの部分はXML APIレジストリ( xml/vk.xml )の記述から生成されます。 ヘッダーファイルを除き、生成されたファイルはリポジトリにチェックインされません。 vk.xmlを変更した場合は、 xml/に移動してヘッダを再生成することができます。

$ make clean install

生成された他のファイルは、トップレベルのMakefile依存関係を介して必要に応じてビルドされます。







-KhronosGroup

執筆者: