Skip to content

Commit

Permalink
Cleanup Vulkan Spec chapter (#288)
Browse files Browse the repository at this point in the history
  • Loading branch information
@spencer-lunarg
spencer-lunarg authored Jan 17, 2025
1 parent 0291fa2 commit 0c65622
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 219 deletions.
95 changes: 22 additions & 73 deletions chapters/vulkan_spec.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2019-2022 The Khronos Group, Inc.
// Copyright 2019-2025 The Khronos Group, Inc.
// SPDX-License-Identifier: CC-BY-4.0

// Required for both single-page and combined guide xrefs to work
Expand All @@ -21,89 +21,38 @@ The Vulkan Spec can be built for any version and with any permutation of extensi

When building the Vulkan Spec, you pass in what version of Vulkan to build for as well as what extensions to include. A Vulkan Spec without any extensions is also referred to as the link:https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#extendingvulkan-coreversions[core version] as it is the minimal amount of Vulkan an implementation needs to support in order to be xref:{chapters}vulkan_cts.adoc#vulkan-cts[conformant].

== Vulkan Spec Version

Vulkan 1.0 to 1.3, there was a dedicated version of the spec. To to reduce build permutation, starting with Vulkan 1.4 there is now a `latest` version that will always be updated to the latest version of Vulkan.

The link:https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.html[Vulkan SDK] will always contain the version of the spec that it was created with.

== Vulkan Spec Format

The Vulkan Spec can be built into different formats.

=== HTML Chunked

Due to the size of the Vulkan Spec, a chunked version is the default when you visit the default `index.html` page.

Example: link:https://registry.khronos.org/vulkan/specs/1.3/html/[https://registry.khronos.org/vulkan/specs/1.3/html/]

Prebuilt HTML Chunked Vulkan Spec

* The Vulkan SDK comes packaged with the chunked version of the spec. Each Vulkan SDK version includes the corresponding spec version. See the link:https://vulkan.lunarg.com/doc/sdk/latest/windows/chunked_spec/index.html[Chunked Specification] for the latest Vulkan SDK.
* Vulkan 1.0 Specification
** link:https://registry.khronos.org/vulkan/specs/1.0/html/[Core]
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/html/[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/html/[Core with WSI Extensions]
* Vulkan 1.1 Specification
** link:https://registry.khronos.org/vulkan/specs/1.1/html/[Core]
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/html/[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/html/[Core with KHR Extensions]
* Vulkan 1.2 Specification
** link:https://registry.khronos.org/vulkan/specs/1.2/html/[Core]
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/html/[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/html/[Core with KHR Extensions]
* Vulkan 1.3 Specification
** link:https://registry.khronos.org/vulkan/specs/1.3/html/[Core]
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/html/[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/html/[Core with KHR Extensions]

=== HTML Full

If you want to view the Vulkan Spec in its entirety as HTML, you just need to view the `vkspec.html` file.

Example: https://registry.khronos.org/vulkan/specs/1.3/html/vkspec.html

Prebuilt HTML Full Vulkan Spec

* The Vulkan SDK comes packaged with Vulkan Spec in its entirety as HTML for the version corresponding to the Vulkan SDK version. See the link:https://vulkan.lunarg.com/doc/sdk/latest/windows/vkspec.html[HTML version of the Specification] for the latest Vulkan SDK. (Note: Slow to load. The advantage of the full HTML version is its searching capability).
* Vulkan 1.0 Specification
** link:https://registry.khronos.org/vulkan/specs/1.0/html/vkspec.html[Core]
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/html/vkspec.html[Core with Extensions ]
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/html/vkspec.html[Core with WSI Extensions]
* Vulkan 1.1 Specification
** link:https://registry.khronos.org/vulkan/specs/1.1/html/vkspec.html[Core]
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/html/vkspec.html[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/html/vkspec.html[Core with KHR Extensions]
* Vulkan 1.2 Specification
** link:https://registry.khronos.org/vulkan/specs/1.2/html/vkspec.html[Core]
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/html/vkspec.html[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/html/vkspec.html[Core with KHR Extensions]
* Vulkan 1.3 Specification
** link:https://registry.khronos.org/vulkan/specs/1.3/html/vkspec.html[Core]
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/html/vkspec.html[Core with KHR Extensions]
=== Antora

To both combine various resources and improve navigation, there is now an link:https://docs.vulkan.org/spec/latest/index.html[Antora built version of the spec] that is recommanded to use.

=== HTML

If you want to view the Vulkan Spec in its entirety as HTML, you just need to view the `html/vkspec.html` file.

https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html

The Vulkan SDK comes packaged with Vulkan Spec in its entirety as HTML for the version corresponding to the Vulkan SDK version. (https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.html)

=== PDF

To view the PDF format, visit the `pdf/vkspec.pdf` file.

Example: https://registry.khronos.org/vulkan/specs/1.3/pdf/vkspec.pdf

Prebuilt PDF Vulkan Spec

* Vulkan 1.0 Specification
** link:https://registry.khronos.org/vulkan/specs/1.0/pdf/vkspec.pdf[Core]
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/pdf/vkspec.pdf[Core with Extensions ]
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/pdf/vkspec.pdf[Core with WSI Extensions]
* Vulkan 1.1 Specification
** link:https://registry.khronos.org/vulkan/specs/1.1/pdf/vkspec.pdf[Core]
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/pdf/vkspec.pdf[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
* Vulkan 1.2 Specification
** link:https://registry.khronos.org/vulkan/specs/1.2/pdf/vkspec.pdf[Core]
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/pdf/vkspec.pdf[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
* Vulkan 1.3 Specification
** link:https://registry.khronos.org/vulkan/specs/1.3/pdf/vkspec.pdf[Core]
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/pdf/vkspec.pdf[Core with Extensions]
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
https://registry.khronos.org/vulkan/specs/latest/pdf/vkspec.pdf

The Vulkan SDK also comes with a PDF version (https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.pdf)

=== Man pages

The Khronos Group currently only host the Vulkan Man Pages for the latest version of the 1.3 spec, with all extensions, on the link:https://registry.khronos.org/vulkan/specs/latest/man/html/[online registry].
The Khronos Group currently only host the Vulkan Man Pages for the latest version of the spec, with all extensions, on the link:https://registry.khronos.org/vulkan/specs/latest/man/html/[online registry].

The Vulkan Man Pages can also be found in the VulkanSDK for each SDK version. See the link:https://vulkan.lunarg.com/doc/sdk/latest/windows/apispec.html[Man Pages] for the latest Vulkan SDK.
95 changes: 22 additions & 73 deletions lang/jp/chapters/vulkan_spec.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2019-2022 The Khronos Group, Inc.
// Copyright 2019-2025 The Khronos Group, Inc.
// SPDX-License-Identifier: CC-BY-4.0

// Required for both single-page and combined guide xrefs to work
Expand All @@ -20,89 +20,38 @@ Vulkan Spec は、どのバージョンでも、どのような拡張機能の

Vulkan Spec をビルドする際には、どのバージョン用か、どの拡張機能を含めるかを指定します。拡張機能を含まない Vulkan Spec はlink:https://www.khronos.org/registry/vulkan/specs/1.3/html/vkspec.html#extendingvulkan-coreversions[コアバージョン]とも呼ばれ、link:./../../../chapters/vulkan_cts.md[適合]するために実装がサポートするべき最小限の Vulkan となります。

== Vulkan Spec バージョン

Vulkan 1.0から1.3までは、スペックの専用バージョンがありました。ビルドの順列を減らすために、Vulkan 1.4から、常にVulkanの最新バージョンに更新される`latest`バージョンが存在するようになりました。

リンク:https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.html[Vulkan SDK]は、常にそれが作成された仕様のバージョンを含んでいます。

== Vulkan Spec フォーマット

Vulkan Spec は、さまざまなフォーマットに対応しています。

=== HTML チャンク

Vulkan Spec のサイズは大きいため、デフォルトの `index.html` ページにアクセスすると、チャンク版がデフォルトで表示されます。

例：link:https://www.khronos.org/registry/vulkan/specs/1.3/html/[https://www.khronos.org/registry/vulkan/specs/1.3/html/]

ビルド済み HTML チャンク Vulkan Spec

* Vulkan SDK には、チャンク版の仕様書がパッケージされています。各バージョンの Vulkan SDK には、対応するバージョンの仕様書が含まれています。最新の Vulkan SDK については、link:https://vulkan.lunarg.com/doc/sdk/latest/windows/chunked_spec/index.html[Chunked Specification] をご覧ください。
* Vulkan 1.0 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.0/html/[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/html/[コアと WSI 拡張機能]
* Vulkan 1.1 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.1/html/[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/html/[コアと KHR 拡張機能]
* Vulkan 1.2 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.2/html/[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/html/[コアと KHR 拡張機能]
* Vulkan 1.3 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.3/html/[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/html/[コアと KHR 拡張機能]

=== HTML フル

Vulkan Spec 全体を HTML で見るには、`vkspec.html` ファイルを表示します。

例： https://www.khronos.org/registry/vulkan/specs/1.3/html/vkspec.html

ビルド済み HTML フル Vulkan Spec

* Vulkan SDK には、対応したバージョンの Vulkan Spec が HTML として丸ごとパッケージされています。最新の Vulkan SDK に対応するバージョンの link:https://vulkan.lunarg.com/doc/sdk/latest/windows/vkspec.html[HTML 版の Specification] をご覧ください。（注意：読み込みに時間がかかります。フル HTML 版の利点は検索機能です。）
* Vulkan 1.0 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/html/vkspec.html[コアと WSI 拡張機能]
* Vulkan 1.1 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.1/html/vkspec.html[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
* Vulkan 1.2 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.2/html/vkspec.html[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
* Vulkan 1.3 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.3/html/vkspec.html[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/vkspec.html[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
=== Antora

様々なリソースを統合し、ナビゲーションを改善するために、link:https://docs.vulkan.org/spec/latest/index.html[AntoraでビルドされたバージョンのSpec]の使用が推奨されています。

=== HTML

Vulkan Spec 全体を HTML で見るには、`html/vkspec.html` ファイルを表示します。

https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html

Vulkan SDK には、対応したバージョンの Vulkan Spec が HTML として丸ごとパッケージされています。最新の Vulkan SDK に対応するバージョンの link:https://vulkan.lunarg.com/doc/sdk/latest/windows/vkspec.html[HTML 版の Specification] をご覧ください。

=== PDF

PDF フォーマットは `pdf/vkspec.pdf` ファイルをご覧ください。

例： https://www.khronos.org/registry/vulkan/specs/1.3/pdf/vkspec.pdf

ビルド済み PDF Vulkan Spec

* Vulkan 1.0 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.0/pdf/vkspec.pdf[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/pdf/vkspec.pdf[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/pdf/vkspec.pdf[コアと WSI 拡張機能]
* Vulkan 1.1 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.1/pdf/vkspec.pdf[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/pdf/vkspec.pdf[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
* Vulkan 1.2 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.2/pdf/vkspec.pdf[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/pdf/vkspec.pdf[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
* Vulkan 1.3 Specification
** link:https://www.khronos.org/registry/vulkan/specs/1.3/pdf/vkspec.pdf[コア]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/pdf/vkspec.pdf[コアと拡張機能]
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
https://registry.khronos.org/vulkan/specs/latest/pdf/vkspec.pdf

Vulkan SDKにもPDF版が付属しています（https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.pdf）。

=== マニュアルページ

Khronos Group は現在、最新バージョンの1.3仕様のすべての拡張機能を含む Vulkan Man Pages のみを link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/[オンラインレジストリ]でホストしています。
Khronos Group は現在、最新バージョンの仕様のすべての拡張機能を含む Vulkan Man Pages のみを link:https://registry.khronos.org/vulkan/specs/latest/man/html/[オンラインレジストリ]でホストしています。

また、Vulkan Man Pages は、各バージョンの Vulkan SDK にも掲載されています。最新の Vulkan SDK の link:https://vulkan.lunarg.com/doc/sdk/latest/windows/apispec.html[マニュアルページ] をご覧ください。
Loading

0 comments on commit 0c65622

Please sign in to comment.