Skip to content

Commit 0c65622

Browse files
spencer-lunargspencer-lunarg
authored
Cleanup Vulkan Spec chapter (#288)
1 parent 0291fa2 commit 0c65622

File tree

3 files changed

+68
-219
lines changed

3 files changed

+68
-219
lines changed

‎chapters/vulkan_spec.adoc‎

Lines changed: 22 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019-2022 The Khronos Group, Inc.
1+
// Copyright 2019-2025 The Khronos Group, Inc.
22
// SPDX-License-Identifier: CC-BY-4.0
33

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

2222
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].
2323

24+
== Vulkan Spec Version
25+
26+
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.
27+
28+
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.
29+
2430
== Vulkan Spec Format
2531

2632
The Vulkan Spec can be built into different formats.
2733

28-
=== HTML Chunked
29-
30-
Due to the size of the Vulkan Spec, a chunked version is the default when you visit the default `index.html` page.
31-
32-
Example: link:https://registry.khronos.org/vulkan/specs/1.3/html/[https://registry.khronos.org/vulkan/specs/1.3/html/]
33-
34-
Prebuilt HTML Chunked Vulkan Spec
35-
36-
* 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.
37-
* Vulkan 1.0 Specification
38-
** link:https://registry.khronos.org/vulkan/specs/1.0/html/[Core]
39-
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/html/[Core with Extensions]
40-
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/html/[Core with WSI Extensions]
41-
* Vulkan 1.1 Specification
42-
** link:https://registry.khronos.org/vulkan/specs/1.1/html/[Core]
43-
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/html/[Core with Extensions]
44-
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/html/[Core with KHR Extensions]
45-
* Vulkan 1.2 Specification
46-
** link:https://registry.khronos.org/vulkan/specs/1.2/html/[Core]
47-
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/html/[Core with Extensions]
48-
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/html/[Core with KHR Extensions]
49-
* Vulkan 1.3 Specification
50-
** link:https://registry.khronos.org/vulkan/specs/1.3/html/[Core]
51-
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/html/[Core with Extensions]
52-
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/html/[Core with KHR Extensions]
53-
54-
=== HTML Full
55-
56-
If you want to view the Vulkan Spec in its entirety as HTML, you just need to view the `vkspec.html` file.
57-
58-
Example: https://registry.khronos.org/vulkan/specs/1.3/html/vkspec.html
59-
60-
Prebuilt HTML Full Vulkan Spec
61-
62-
* 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).
63-
* Vulkan 1.0 Specification
64-
** link:https://registry.khronos.org/vulkan/specs/1.0/html/vkspec.html[Core]
65-
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/html/vkspec.html[Core with Extensions ]
66-
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/html/vkspec.html[Core with WSI Extensions]
67-
* Vulkan 1.1 Specification
68-
** link:https://registry.khronos.org/vulkan/specs/1.1/html/vkspec.html[Core]
69-
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/html/vkspec.html[Core with Extensions]
70-
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/html/vkspec.html[Core with KHR Extensions]
71-
* Vulkan 1.2 Specification
72-
** link:https://registry.khronos.org/vulkan/specs/1.2/html/vkspec.html[Core]
73-
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/html/vkspec.html[Core with Extensions]
74-
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/html/vkspec.html[Core with KHR Extensions]
75-
* Vulkan 1.3 Specification
76-
** link:https://registry.khronos.org/vulkan/specs/1.3/html/vkspec.html[Core]
77-
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html[Core with Extensions]
78-
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/html/vkspec.html[Core with KHR Extensions]
34+
=== Antora
35+
36+
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.
37+
38+
=== HTML
39+
40+
If you want to view the Vulkan Spec in its entirety as HTML, you just need to view the `html/vkspec.html` file.
41+
42+
https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html
43+
44+
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)
7945

8046
=== PDF
8147

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

84-
Example: https://registry.khronos.org/vulkan/specs/1.3/pdf/vkspec.pdf
85-
86-
Prebuilt PDF Vulkan Spec
87-
88-
* Vulkan 1.0 Specification
89-
** link:https://registry.khronos.org/vulkan/specs/1.0/pdf/vkspec.pdf[Core]
90-
** link:https://registry.khronos.org/vulkan/specs/1.0-extensions/pdf/vkspec.pdf[Core with Extensions ]
91-
** link:https://registry.khronos.org/vulkan/specs/1.0-wsi_extensions/pdf/vkspec.pdf[Core with WSI Extensions]
92-
* Vulkan 1.1 Specification
93-
** link:https://registry.khronos.org/vulkan/specs/1.1/pdf/vkspec.pdf[Core]
94-
** link:https://registry.khronos.org/vulkan/specs/1.1-extensions/pdf/vkspec.pdf[Core with Extensions]
95-
** link:https://registry.khronos.org/vulkan/specs/1.1-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
96-
* Vulkan 1.2 Specification
97-
** link:https://registry.khronos.org/vulkan/specs/1.2/pdf/vkspec.pdf[Core]
98-
** link:https://registry.khronos.org/vulkan/specs/1.2-extensions/pdf/vkspec.pdf[Core with Extensions]
99-
** link:https://registry.khronos.org/vulkan/specs/1.2-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
100-
* Vulkan 1.3 Specification
101-
** link:https://registry.khronos.org/vulkan/specs/1.3/pdf/vkspec.pdf[Core]
102-
** link:https://registry.khronos.org/vulkan/specs/1.3-extensions/pdf/vkspec.pdf[Core with Extensions]
103-
** link:https://registry.khronos.org/vulkan/specs/1.3-khr-extensions/pdf/vkspec.pdf[Core with KHR Extensions]
50+
https://registry.khronos.org/vulkan/specs/latest/pdf/vkspec.pdf
51+
52+
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)
10453

10554
=== Man pages
10655

107-
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].
56+
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].
10857

10958
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.

‎lang/jp/chapters/vulkan_spec.adoc‎

Lines changed: 22 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019-2022 The Khronos Group, Inc.
1+
// Copyright 2019-2025 The Khronos Group, Inc.
22
// SPDX-License-Identifier: CC-BY-4.0
33

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

2121
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 となります。
2222

23+
== Vulkan Spec バージョン
24+
25+
Vulkan 1.0から1.3までは、スペックの専用バージョンがありました。ビルドの順列を減らすために、Vulkan 1.4から、常にVulkanの最新バージョンに更新される`latest`バージョンが存在するようになりました。
26+
27+
リンク:https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.html[Vulkan SDK]は、常にそれが作成された仕様のバージョンを含んでいます。
28+
2329
== Vulkan Spec フォーマット
2430

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

27-
=== HTML チャンク
28-
29-
Vulkan Spec のサイズは大きいため、デフォルトの `index.html` ページにアクセスすると、チャンク版がデフォルトで表示されます。
30-
31-
例：link:https://www.khronos.org/registry/vulkan/specs/1.3/html/[https://www.khronos.org/registry/vulkan/specs/1.3/html/]
32-
33-
ビルド済み HTML チャンク Vulkan Spec
34-
35-
* Vulkan SDK には、チャンク版の仕様書がパッケージされています。各バージョンの Vulkan SDK には、対応するバージョンの仕様書が含まれています。最新の Vulkan SDK については、link:https://vulkan.lunarg.com/doc/sdk/latest/windows/chunked_spec/index.html[Chunked Specification] をご覧ください。
36-
* Vulkan 1.0 Specification
37-
** link:https://www.khronos.org/registry/vulkan/specs/1.0/html/[コア]
38-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/[コアと拡張機能]
39-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/html/[コアと WSI 拡張機能]
40-
* Vulkan 1.1 Specification
41-
** link:https://www.khronos.org/registry/vulkan/specs/1.1/html/[コア]
42-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/[コアと拡張機能]
43-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/html/[コアと KHR 拡張機能]
44-
* Vulkan 1.2 Specification
45-
** link:https://www.khronos.org/registry/vulkan/specs/1.2/html/[コア]
46-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/[コアと拡張機能]
47-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/html/[コアと KHR 拡張機能]
48-
* Vulkan 1.3 Specification
49-
** link:https://www.khronos.org/registry/vulkan/specs/1.3/html/[コア]
50-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/[コアと拡張機能]
51-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/html/[コアと KHR 拡張機能]
52-
53-
=== HTML フル
54-
55-
Vulkan Spec 全体を HTML で見るには、`vkspec.html` ファイルを表示します。
56-
57-
例： https://www.khronos.org/registry/vulkan/specs/1.3/html/vkspec.html
58-
59-
ビルド済み HTML フル Vulkan Spec
60-
61-
* Vulkan SDK には、対応したバージョンの Vulkan Spec が HTML として丸ごとパッケージされています。最新の Vulkan SDK に対応するバージョンの link:https://vulkan.lunarg.com/doc/sdk/latest/windows/vkspec.html[HTML 版の Specification] をご覧ください。（注意：読み込みに時間がかかります。フル HTML 版の利点は検索機能です。）
62-
* Vulkan 1.0 Specification
63-
** link:https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html[コア]
64-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html[コアと拡張機能]
65-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/html/vkspec.html[コアと WSI 拡張機能]
66-
* Vulkan 1.1 Specification
67-
** link:https://www.khronos.org/registry/vulkan/specs/1.1/html/vkspec.html[コア]
68-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html[コアと拡張機能]
69-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
70-
* Vulkan 1.2 Specification
71-
** link:https://www.khronos.org/registry/vulkan/specs/1.2/html/vkspec.html[コア]
72-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html[コアと拡張機能]
73-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
74-
* Vulkan 1.3 Specification
75-
** link:https://www.khronos.org/registry/vulkan/specs/1.3/html/vkspec.html[コア]
76-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/vkspec.html[コアと拡張機能]
77-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/html/vkspec.html[コアと KHR 拡張機能]
33+
=== Antora
34+
35+
様々なリソースを統合し、ナビゲーションを改善するために、link:https://docs.vulkan.org/spec/latest/index.html[AntoraでビルドされたバージョンのSpec]の使用が推奨されています。
36+
37+
=== HTML
38+
39+
Vulkan Spec 全体を HTML で見るには、`html/vkspec.html` ファイルを表示します。
40+
41+
https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html
42+
43+
Vulkan SDK には、対応したバージョンの Vulkan Spec が HTML として丸ごとパッケージされています。最新の Vulkan SDK に対応するバージョンの link:https://vulkan.lunarg.com/doc/sdk/latest/windows/vkspec.html[HTML 版の Specification] をご覧ください。
7844

7945
=== PDF
8046

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

83-
例： https://www.khronos.org/registry/vulkan/specs/1.3/pdf/vkspec.pdf
84-
85-
ビルド済み PDF Vulkan Spec
86-
87-
* Vulkan 1.0 Specification
88-
** link:https://www.khronos.org/registry/vulkan/specs/1.0/pdf/vkspec.pdf[コア]
89-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-extensions/pdf/vkspec.pdf[コアと拡張機能]
90-
** link:https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/pdf/vkspec.pdf[コアと WSI 拡張機能]
91-
* Vulkan 1.1 Specification
92-
** link:https://www.khronos.org/registry/vulkan/specs/1.1/pdf/vkspec.pdf[コア]
93-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-extensions/pdf/vkspec.pdf[コアと拡張機能]
94-
** link:https://www.khronos.org/registry/vulkan/specs/1.1-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
95-
* Vulkan 1.2 Specification
96-
** link:https://www.khronos.org/registry/vulkan/specs/1.2/pdf/vkspec.pdf[コア]
97-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/pdf/vkspec.pdf[コアと拡張機能]
98-
** link:https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
99-
* Vulkan 1.3 Specification
100-
** link:https://www.khronos.org/registry/vulkan/specs/1.3/pdf/vkspec.pdf[コア]
101-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-extensions/pdf/vkspec.pdf[コアと拡張機能]
102-
** link:https://www.khronos.org/registry/vulkan/specs/1.3-khr-extensions/pdf/vkspec.pdf[コアと KHR 拡張機能]
49+
https://registry.khronos.org/vulkan/specs/latest/pdf/vkspec.pdf
50+
51+
Vulkan SDKにもPDF版が付属しています（https://vulkan.lunarg.com/doc/sdk/1.4.304.0/windows/1.4-extensions/vkspec.pdf）。
10352

10453
=== マニュアルページ
10554

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

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

0 commit comments

Comments
 (0)