README-jp.adoc

Vulkan^® Guide

Vulkan Guide は、開発者が Vulkan の世界へ足を踏み出すための手助けをするものです。このガイドは気軽に読める内容を目指しており、知りたいトピックに対して参考になるさまざまな資料を紹介します。ここには、Vulkan の多くのニュアンスに対する理解を促すための情報が記載されています。

Note	Vulkan Guide は、asciidoctor guide.adoc を使って1つのページとしてビルドできます。

1. 概要

1.1. Vulkan とは？

1.2. Vulkan で出来ること

1.3. Vulkan Spec

1.4. プラットフォーム

1.5. 対応の確認

1.6. バージョン

1.7. Vulkan Release Summary

1.8. SPIR-V とは？

1.9. 移植性に関わるイニシアチブ

1.10. Vulkan CTS

1.11. Vulkan 開発ツール

1.12. Vulkan Validation の概要

1.13. Vulkan で使われる用語の対応表 (GL、GLES、DirectX、Metal)

2. Vulkan の使い方

2.1. ローダ

2.2. レイヤ

2.3. プロパティ、拡張機能、機能、制限、フォーマットのクエリ

2.3.1. Vulkan 拡張機能の有効化

2.3.2. Vulkan 機能の有効化

2.3.3. SPIR-V 拡張機能の使い方

2.3.4. フォーマット

2.4. キューとキューファミリ

2.5. WSI

2.6. pNext と sType

2.7. 同期

2.7.1. VK_KHR_synchronization2 への移植

2.8. メモリ割り当ての戦略

2.8.1. スパースリソース（Sparse Resources）

2.8.2. 保護されたメモリ

2.9. パイプライン キャッシング/派生

2.10. スレッド化

2.11. 深度

• VK_EXT_depth_range_unrestricted, VK_EXT_depth_clip_enable, VK_EXT_depth_clip_control

2.12. シェーダへのデータマッピング

2.12.1. 頂点入力データ処理

2.12.2. ディスクリプタ動的オフセット

2.13. 堅牢性

• VK_EXT_image_robustness, VK_EXT_robustness2

2.14. 動的な状態（Dynamic State）

• VK_EXT_extended_dynamic_state, VK_EXT_extended_dynamic_state2, VK_EXT_extended_dynamic_state3, VK_EXT_vertex_input_dynamic_state, VK_EXT_color_write_enable, VK_EXT_attachment_feedback_loop_dynamic_state

2.14.1. 動的な状態のマップ（Dynamic State Map）

2.15. サブグループ

• VK_EXT_subgroup_size_control, VK_KHR_shader_subgroup_extended_types, VK_EXT_shader_subgroup_ballot, VK_EXT_shader_subgroup_vote

2.16. シェーダメモリレイアウト

• VK_KHR_uniform_buffer_standard_layout, VK_KHR_relaxed_block_layout, VK_EXT_scalar_block_layout

2.17. アトミック

• VK_KHR_shader_atomic_int64, VK_EXT_shader_image_atomic_int64, VK_EXT_shader_atomic_float, VK_EXT_shader_atomic_float2

2.18. よくある落とし穴

2.19. HLSL シェーダの使い方

3. 拡張機能を使うタイミングと理由

Note	さまざまな Vulkan Extensions の補足的なリファレンスです。各拡張機能の詳細については、Vulkan Spec を参照してください。

3.1. クリーンアップ拡張機能

• VK_EXT_4444_formats, VK_KHR_bind_memory2, VK_KHR_create_renderpass2, VK_KHR_dedicated_allocation, VK_KHR_driver_properties, VK_KHR_get_memory_requirements2, VK_KHR_get_physical_device_properties2, VK_EXT_host_query_reset, VK_KHR_maintenance1, VK_KHR_maintenance2, VK_KHR_maintenance3, VK_KHR_maintenance4, VK_KHR_maintenance5, VK_KHR_maintenance6, VK_KHR_separate_depth_stencil_layouts, VK_KHR_depth_stencil_resolve, VK_EXT_separate_stencil_usage, VK_EXT_sampler_filter_minmax, VK_KHR_sampler_mirror_clamp_to_edge, VK_EXT_ycbcr_2plane_444_formats, VK_KHR_format_feature_flags2, VK_EXT_rgba10x6_formats, VK_KHR_copy_commands2

3.2. デバイスグループ

• VK_KHR_device_group, VK_KHR_device_group_creation

3.3. 外部メモリと同期

• VK_KHR_external_fence, VK_KHR_external_memory, VK_KHR_external_semaphore

3.4. レイトレーシング

• VK_KHR_acceleration_structure, VK_KHR_ray_tracing_pipeline, VK_KHR_ray_query, VK_KHR_pipeline_library, VK_KHR_deferred_host_operations

3.5. シェーダ機能

• VK_KHR_8bit_storage, VK_KHR_16bit_storage, VK_KHR_shader_clock, VK_EXT_shader_demote_to_helper_invocation, VK_KHR_shader_draw_parameters, VK_KHR_shader_float16_int8, VK_KHR_shader_float_controls, VK_KHR_shader_non_semantic_info, VK_EXT_shader_stencil_export, VK_KHR_shader_terminate_invocation, VK_EXT_shader_viewport_index_layer, VK_KHR_spirv_1_4, VK_KHR_storage_buffer_storage_class, VK_KHR_variable_pointers, VK_KHR_vulkan_memory_model, VK_KHR_workgroup_memory_explicit_layout, VK_KHR_zero_initialize_workgroup_memory

3.6. 変換レイヤ拡張機能

• VK_EXT_custom_border_color, VK_EXT_border_color_swizzle, VK_EXT_depth_clip_enable, VK_EXT_depth_clip_control, VK_EXT_provoking_vertex, VK_EXT_transform_feedback, VK_EXT_image_view_min_lod

3.7. VK_EXT_descriptor_indexing

3.8. VK_EXT_inline_uniform_block

3.9. VK_EXT_memory_priority

3.10. VK_KHR_descriptor_update_template

3.11. VK_KHR_draw_indirect_count

3.12. VK_KHR_image_format_list

3.13. VK_KHR_imageless_framebuffer

3.14. VK_KHR_sampler_ycbcr_conversion

3.15. VK_KHR_timeline_semaphore

3.16. VK_KHR_dynamic_rendering

3.17. VK_KHR_shader_subgroup_uniform_control_flow

4. 貢献

5. ライセンス

6. 行動規範