KhronosGroup · SaschaWillems · Aug 21, 2023 · Aug 21, 2023 · Aug 21, 2023 · Aug 21, 2023
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,6 @@ ads.txt
 build_ebook.log
 temp_ebook.md
 ebook/*.pdf
-ebook/*.epub
+ebook/*.epub
+
+convert.py
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,17 @@
+= Khronos Vulkan^®^ Tutorial
+
+== Attribution
+
+The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial.com/[Vulkan Tutorial]" by Alexander Overvoorde licensed under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0].
+
+== About
+
+This repository hosts the contents of the link:https:://learn.vulkan.org/vulkan-tutorial[Khronos Vulkan Tutorial]. The tutorial is part of the link:https://github.com/KhronosGroup/Vulkan-Site[Vulkan Documentation Project].
+
+== License
+
+The contents of this repository are licensed as https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0], unless stated otherwise.
+By contributing to this repository, you agree to license your contributions to the public under that same license.
+
+The code listings in the `code` directory are licensed as https://creativecommons.org/publicdomain/zero/1.0/[CC0 1.0 Universal].
+By contributing to that directory, you agree to license your contributions to the public under that same public domain-like license.
diff --git a/README.md b/README.md
diff --git a/antora/.gitignore b/antora/.gitignore
@@ -0,0 +1,4 @@
+modules/ROOT/attachments/**
+modules/ROOT/images/**
+modules/ROOT/pages/**
+!modules/ROOT/pages/index.adoc
diff --git a/antora/Makefile b/antora/Makefile
@@ -0,0 +1,35 @@
+# Copyright (c) 2023 Sascha Willems
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
+# Configure the Khronos Vulkan Samples Antora tree with transformed markup files
+
+RMRF = rm -rf
+CP = cp
+
+# Antora ROOT module directory where files are copied
+ROOT = modules/ROOT
+
+# Some Antora related documentation files are fixed and and shouldn't be delete
+EXCLUDE = 'index.adoc'
+
+setup: setup_tutorial
+
+setup_tutorial:
+# In order to keep the image links we need to have the image folder inside the image folder (due to how Antora works)
+	mkdir -p $(ROOT)/images/images
+	rsync -a --delete ../images $(ROOT)/images
+	rsync -a --delete ../attachments $(ROOT)
+	mkdir -p $(ROOT)/pages
+	rsync -a --delete --exclude ${EXCLUDE} ../en/ $(ROOT)/pages
+# Use a python script to automat some file content changes that are necessary due to differences between Antora and github
+	python3 make_helper.py
+
+# @todo
+# Files generated by 'setup' target
+# ANTORA_GENERATED = \
+#  	$(filter-out $(ROOT)/pages/index.adoc,$(wildcard $(ROOT)/pages/*.adoc)) \
+#  	$(ROOT)/pages/extensions \
+#  	$(ROOT)/images
+
+# clean:
+# 	$(RMRF) $(ANTORA_GENERATED)
diff --git a/antora/antora.yml b/antora/antora.yml
@@ -0,0 +1,9 @@
+# Copyright (c) 2023 Sascha Willems
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
+name: tutorial
+title: Khronos Vulkan Tutorial
+version: latest
+start_page: 00_Introduction.adoc
+nav:
+- modules/ROOT/nav.adoc
diff --git a/antora/make_helper.py b/antora/make_helper.py
@@ -0,0 +1,24 @@
+# Copyright (c) 2023 Sascha Willems
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
+# Does automated changes to the asciidoc files required to make them properly work with Antora
+
+import os
+
+for root, dirs, files in os.walk("modules/ROOT/pages/"):
+    for file in files:
+        if (file.endswith(".adoc")):    
+            file_name = os.path.join(root, file);            
+            print("Fixing " + file_name)
+            s = ""
+            with open(file_name, "r+") as f:
+                if file in ["index.adoc"]:
+                    continue
+                s = f.read()
+                f.seek(0)
+                f.truncate()
+                # We need to change the attachment links (e.g. used to link to the chapter's source files)
+                # It's not possible to format them in a way to works both with github and Antora
+                s = s.replace("link:/attachments/", "link:{attachmentsdir}/")
+                f.write(s)
+                f.close
diff --git a/antora/modules/ROOT/nav.adoc b/antora/modules/ROOT/nav.adoc
@@ -0,0 +1,49 @@
+////
+- Copyright (c) 2023, Sascha Willems
+- SPDX-License-Identifier: CC-BY-SA-4.0
+////
+
+* xref:00_Introduction.adoc[Introduction]
+* xref:01_Overview.adoc[Overview]
+* xref:02_Development_environment.adoc[Development environment]
+* xref:03_Drawing_a_triangle/00_Setup/00_Base_code.adoc[Drawing a triangle]
+** xref:03_Drawing_a_triangle/00_Setup/00_Base_code.adoc[Setup]
+*** xref:03_Drawing_a_triangle/00_Setup/00_Base_code.adoc[Base Code]
+*** xref:03_Drawing_a_triangle/00_Setup/01_Instance.adoc[Instance]
+*** xref:03_Drawing_a_triangle/00_Setup/02_Validation_layers.adoc[Validation layers]
+*** xref:03_Drawing_a_triangle/00_Setup/03_Physical_devices_and_queue_families.adoc[Physical devices and queue families]
+*** xref:03_Drawing_a_triangle/00_Setup/04_Logical_device_and_queues.adoc[Logical device and queues]
+** xref:03_Drawing_a_triangle/01_Presentation/00_Window_surface.adoc[Presentation]
+*** xref:03_Drawing_a_triangle/01_Presentation/00_Window_surface.adoc[Window surface]
+*** xref:03_Drawing_a_triangle/01_Presentation/01_Swap_chain.adoc[Swap chain]
+*** xref:03_Drawing_a_triangle/01_Presentation/02_Image_views.adoc[Image views]
+** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/00_Introduction.adoc[Graphics pipeline basics]
+*** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/00_Introduction.adoc[Introduction]
+*** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/01_Shader_modules.adoc[Shader modules]
+*** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/02_Fixed_functions.adoc[Fixed functions]
+*** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.adoc[Render passes]
+*** xref:03_Drawing_a_triangle/02_Graphics_pipeline_basics/04_Conclusion.adoc[Conclusion]
+** xref:03_Drawing_a_triangle/03_Drawing/00_Framebuffers.adoc[Drawing]
+*** xref:03_Drawing_a_triangle/03_Drawing/00_Framebuffers.adoc[Framebuffers]
+*** xref:03_Drawing_a_triangle/03_Drawing/01_Command_buffers.adoc[Command buffers]
+*** xref:03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.adoc[Rendering and presentation]
+*** xref:03_Drawing_a_triangle/03_Drawing/03_Frames_in_flight.adoc[Frames in flight]
+** xref:03_Drawing_a_triangle/04_Swap_chain_recreation.adoc[Swap chain recreation]
+* xref:04_Vertex_buffers/00_Vertex_input_description.adoc[Vertex buffers]
+** xref:04_Vertex_buffers/00_Vertex_input_description.adoc[Vertex input description]
+** xref:04_Vertex_buffers/01_Vertex_buffer_creation.adoc[Vertex buffer creation]
+** xref:04_Vertex_buffers/02_Staging_buffer.adoc[Staging buffer]
+** xref:04_Vertex_buffers/03_Index_buffer.adoc[Index buffer]
+* xref:05_Uniform_buffers/00_Descriptor_layout_and_buffer.adoc[Uniform buffers]
+** xref:05_Uniform_buffers/00_Descriptor_layout_and_buffer.adoc[Descriptor layout and buffer]
+** xref:05_Uniform_buffers/01_Descriptor_pool_and_sets.adoc[Descriptor pool and sets]
+* xref:06_Texture_mapping/00_Images.adoc[Texture mapping]
+** xref:06_Texture_mapping/00_Images.adoc[Images]
+** xref:06_Texture_mapping/01_Image_view_and_sampler.adoc[Image view and sampler]
+** xref:06_Texture_mapping/02_Combined_image_sampler.adoc[Combined image sampler]
+* xref:07_Depth_buffering.adoc[Depth buffering]
+* xref:08_Loading_models.adoc[Loading models]
+* xref:09_Generating_Mipmaps.adoc[Generating Mipmaps]
+* xref:10_Multisampling.adoc[Multisampling]
+* xref:11_Compute_Shader.adoc[Compute Shader]
+* xref:90_FAQ.adoc[FAQ]
diff --git a/code/.gitignore → attachments/.gitignore b/code/.gitignore → attachments/.gitignore
diff --git a/code/00_base_code.cpp → attachments/00_base_code.cpp b/code/00_base_code.cpp → attachments/00_base_code.cpp
diff --git a/code/01_instance_creation.cpp → attachments/01_instance_creation.cpp b/code/01_instance_creation.cpp → attachments/01_instance_creation.cpp
diff --git a/code/02_validation_layers.cpp → attachments/02_validation_layers.cpp b/code/02_validation_layers.cpp → attachments/02_validation_layers.cpp
diff --git a/code/03_physical_device_selection.cpp → attachments/03_physical_device_selection.cpp b/code/03_physical_device_selection.cpp → attachments/03_physical_device_selection.cpp
diff --git a/code/04_logical_device.cpp → attachments/04_logical_device.cpp b/code/04_logical_device.cpp → attachments/04_logical_device.cpp
diff --git a/code/05_window_surface.cpp → attachments/05_window_surface.cpp b/code/05_window_surface.cpp → attachments/05_window_surface.cpp
diff --git a/code/06_swap_chain_creation.cpp → attachments/06_swap_chain_creation.cpp b/code/06_swap_chain_creation.cpp → attachments/06_swap_chain_creation.cpp
diff --git a/code/07_image_views.cpp → attachments/07_image_views.cpp b/code/07_image_views.cpp → attachments/07_image_views.cpp
diff --git a/code/08_graphics_pipeline.cpp → attachments/08_graphics_pipeline.cpp b/code/08_graphics_pipeline.cpp → attachments/08_graphics_pipeline.cpp
diff --git a/code/18_shader_vertexbuffer.frag → attachments/09_shader_base.frag b/code/18_shader_vertexbuffer.frag → attachments/09_shader_base.frag
diff --git a/code/09_shader_base.vert → attachments/09_shader_base.vert b/code/09_shader_base.vert → attachments/09_shader_base.vert
@@ -1,20 +1,20 @@
-#version 450
-
-layout(location = 0) out vec3 fragColor;
-
-vec2 positions[3] = vec2[](
-    vec2(0.0, -0.5),
-    vec2(0.5, 0.5),
-    vec2(-0.5, 0.5)
-);
-
-vec3 colors[3] = vec3[](
-    vec3(1.0, 0.0, 0.0),
-    vec3(0.0, 1.0, 0.0),
-    vec3(0.0, 0.0, 1.0)
-);
-
-void main() {
-    gl_Position = vec4(positions[gl_VertexIndex], 0.0, 1.0);
-    fragColor = colors[gl_VertexIndex];
-}
+#version 450
+
+layout(location = 0) out vec3 fragColor;
+
+vec2 positions[3] = vec2[](
+    vec2(0.0, -0.5),
+    vec2(0.5, 0.5),
+    vec2(-0.5, 0.5)
+);
+
+vec3 colors[3] = vec3[](
+    vec3(1.0, 0.0, 0.0),
+    vec3(0.0, 1.0, 0.0),
+    vec3(0.0, 0.0, 1.0)
+);
+
+void main() {
+    gl_Position = vec4(positions[gl_VertexIndex], 0.0, 1.0);
+    fragColor = colors[gl_VertexIndex];
+}
diff --git a/code/09_shader_modules.cpp → attachments/09_shader_modules.cpp b/code/09_shader_modules.cpp → attachments/09_shader_modules.cpp
diff --git a/code/10_fixed_functions.cpp → attachments/10_fixed_functions.cpp b/code/10_fixed_functions.cpp → attachments/10_fixed_functions.cpp
diff --git a/code/11_render_passes.cpp → attachments/11_render_passes.cpp b/code/11_render_passes.cpp → attachments/11_render_passes.cpp
diff --git a/code/12_graphics_pipeline_complete.cpp → ...chments/12_graphics_pipeline_complete.cpp b/code/12_graphics_pipeline_complete.cpp → ...chments/12_graphics_pipeline_complete.cpp
diff --git a/code/13_framebuffers.cpp → attachments/13_framebuffers.cpp b/code/13_framebuffers.cpp → attachments/13_framebuffers.cpp
diff --git a/code/14_command_buffers.cpp → attachments/14_command_buffers.cpp b/code/14_command_buffers.cpp → attachments/14_command_buffers.cpp
diff --git a/code/15_hello_triangle.cpp → attachments/15_hello_triangle.cpp b/code/15_hello_triangle.cpp → attachments/15_hello_triangle.cpp
diff --git a/code/16_frames_in_flight.cpp → attachments/16_frames_in_flight.cpp b/code/16_frames_in_flight.cpp → attachments/16_frames_in_flight.cpp
diff --git a/code/17_swap_chain_recreation.cpp → attachments/17_swap_chain_recreation.cpp b/code/17_swap_chain_recreation.cpp → attachments/17_swap_chain_recreation.cpp
diff --git a/code/22_shader_ubo.frag → attachments/18_shader_vertexbuffer.frag b/code/22_shader_ubo.frag → attachments/18_shader_vertexbuffer.frag
diff --git a/code/18_shader_vertexbuffer.vert → attachments/18_shader_vertexbuffer.vert b/code/18_shader_vertexbuffer.vert → attachments/18_shader_vertexbuffer.vert
diff --git a/code/18_vertex_input.cpp → attachments/18_vertex_input.cpp b/code/18_vertex_input.cpp → attachments/18_vertex_input.cpp
diff --git a/code/19_vertex_buffer.cpp → attachments/19_vertex_buffer.cpp b/code/19_vertex_buffer.cpp → attachments/19_vertex_buffer.cpp
diff --git a/code/20_staging_buffer.cpp → attachments/20_staging_buffer.cpp b/code/20_staging_buffer.cpp → attachments/20_staging_buffer.cpp
diff --git a/code/21_index_buffer.cpp → attachments/21_index_buffer.cpp b/code/21_index_buffer.cpp → attachments/21_index_buffer.cpp
diff --git a/code/22_descriptor_layout.cpp → attachments/22_descriptor_layout.cpp b/code/22_descriptor_layout.cpp → attachments/22_descriptor_layout.cpp
diff --git a/code/09_shader_base.frag → attachments/22_shader_ubo.frag b/code/09_shader_base.frag → attachments/22_shader_ubo.frag
@@ -1,9 +1,9 @@
-#version 450
-
-layout(location = 0) in vec3 fragColor;
-
-layout(location = 0) out vec4 outColor;
-
-void main() {
-    outColor = vec4(fragColor, 1.0);
-}
+#version 450
+
+layout(location = 0) in vec3 fragColor;
+
+layout(location = 0) out vec4 outColor;
+
+void main() {
+    outColor = vec4(fragColor, 1.0);
+}
diff --git a/code/22_shader_ubo.vert → attachments/22_shader_ubo.vert b/code/22_shader_ubo.vert → attachments/22_shader_ubo.vert
diff --git a/code/23_descriptor_sets.cpp → attachments/23_descriptor_sets.cpp b/code/23_descriptor_sets.cpp → attachments/23_descriptor_sets.cpp
diff --git a/code/24_texture_image.cpp → attachments/24_texture_image.cpp b/code/24_texture_image.cpp → attachments/24_texture_image.cpp
diff --git a/code/25_sampler.cpp → attachments/25_sampler.cpp b/code/25_sampler.cpp → attachments/25_sampler.cpp
diff --git a/code/26_shader_textures.frag → attachments/26_shader_textures.frag b/code/26_shader_textures.frag → attachments/26_shader_textures.frag
diff --git a/code/26_shader_textures.vert → attachments/26_shader_textures.vert b/code/26_shader_textures.vert → attachments/26_shader_textures.vert
diff --git a/code/26_texture_mapping.cpp → attachments/26_texture_mapping.cpp b/code/26_texture_mapping.cpp → attachments/26_texture_mapping.cpp
diff --git a/code/27_depth_buffering.cpp → attachments/27_depth_buffering.cpp b/code/27_depth_buffering.cpp → attachments/27_depth_buffering.cpp
diff --git a/code/27_shader_depth.frag → attachments/27_shader_depth.frag b/code/27_shader_depth.frag → attachments/27_shader_depth.frag
diff --git a/code/27_shader_depth.vert → attachments/27_shader_depth.vert b/code/27_shader_depth.vert → attachments/27_shader_depth.vert
diff --git a/code/28_model_loading.cpp → attachments/28_model_loading.cpp b/code/28_model_loading.cpp → attachments/28_model_loading.cpp
diff --git a/code/29_mipmapping.cpp → attachments/29_mipmapping.cpp b/code/29_mipmapping.cpp → attachments/29_mipmapping.cpp
diff --git a/code/30_multisampling.cpp → attachments/30_multisampling.cpp b/code/30_multisampling.cpp → attachments/30_multisampling.cpp
diff --git a/code/31_compute_shader.cpp → attachments/31_compute_shader.cpp b/code/31_compute_shader.cpp → attachments/31_compute_shader.cpp
diff --git a/code/31_shader_compute.comp → attachments/31_shader_compute.comp b/code/31_shader_compute.comp → attachments/31_shader_compute.comp
diff --git a/code/31_shader_compute.frag → attachments/31_shader_compute.frag b/code/31_shader_compute.frag → attachments/31_shader_compute.frag
diff --git a/code/31_shader_compute.vert → attachments/31_shader_compute.vert b/code/31_shader_compute.vert → attachments/31_shader_compute.vert
diff --git a/code/CMakeLists.txt → attachments/CMakeLists.txt b/code/CMakeLists.txt → attachments/CMakeLists.txt
diff --git a/code/incremental_patch.sh → attachments/incremental_patch.sh b/code/incremental_patch.sh → attachments/incremental_patch.sh