Added level one captions to all pages

SaschaWillems · SaschaWillems · commit f282775179b9 · 2024-05-06T19:18:07.000+02:00
Required for proper browser tab titles (would otherwise show as untitled)
diff --git a/en/01_Overview.adoc b/en/01_Overview.adoc
@@ -1,3 +1,5 @@
+= Overview
+
 This chapter will start off with an introduction of Vulkan and the problems it addresses.
 After that we're going to look at the ingredients that are required for the first triangle.
 This will give you a big picture to place each of the subsequent chapters in.
diff --git a/en/02_Development_environment.adoc b/en/02_Development_environment.adoc
@@ -1,3 +1,5 @@
+= Development Environment
+
 :pp: {plus}{plus}
 
 In this chapter we'll set up your environment for developing Vulkan applications and install some useful libraries.
diff --git a/en/03_Drawing_a_triangle/00_Setup/00_Base_code.adoc b/en/03_Drawing_a_triangle/00_Setup/00_Base_code.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Base code
+
 == General structure
 
 In the previous chapter you've created a Vulkan project with all of the proper configuration and tested it with the sample code.
diff --git a/en/03_Drawing_a_triangle/00_Setup/01_Instance.adoc b/en/03_Drawing_a_triangle/00_Setup/01_Instance.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Instance
+
 == Creating an instance
 
 The very first thing you need to do is initialize the Vulkan library by creating an _instance_.
diff --git a/en/03_Drawing_a_triangle/00_Setup/02_Validation_layers.adoc b/en/03_Drawing_a_triangle/00_Setup/02_Validation_layers.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Validation layers
+
 == What are validation layers?
 
 The Vulkan API is designed around the idea of minimal driver overhead and one of the manifestations of that goal is that there is very limited error checking in the API by default.
diff --git a/en/03_Drawing_a_triangle/00_Setup/03_Physical_devices_and_queue_families.adoc b/en/03_Drawing_a_triangle/00_Setup/03_Physical_devices_and_queue_families.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Physical devices and queue families
+
 == Selecting a physical device
 
 After initializing the Vulkan library through a VkInstance we need to look for and select a graphics card in the system that supports the features we need.
diff --git a/en/03_Drawing_a_triangle/00_Setup/04_Logical_device_and_queues.adoc b/en/03_Drawing_a_triangle/00_Setup/04_Logical_device_and_queues.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Logical device and queues
+
 == Introduction
 
 After selecting a physical device to use we need to set up a _logical device_ to interface with it.
diff --git a/en/03_Drawing_a_triangle/01_Presentation/00_Window_surface.adoc b/en/03_Drawing_a_triangle/01_Presentation/00_Window_surface.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Window surface
+
 Since Vulkan is a platform agnostic API, it can not interface directly with the window system on its own.
 To establish the connection between Vulkan and the window system to present results to the screen, we need to use the WSI (Window System Integration) extensions.
 In this chapter we'll discuss the first one, which is `VK_KHR_surface`.
diff --git a/en/03_Drawing_a_triangle/01_Presentation/01_Swap_chain.adoc b/en/03_Drawing_a_triangle/01_Presentation/01_Swap_chain.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Swap chain
+
 Vulkan does not have the concept of a "default framebuffer", hence it requires an infrastructure that will own the buffers we will render to before we visualize them on the screen.
 This infrastructure is known as the _swap chain_ and must be created explicitly in Vulkan.
 The swap chain is essentially a queue of images that are waiting to be presented to the screen.
diff --git a/en/03_Drawing_a_triangle/01_Presentation/02_Image_views.adoc b/en/03_Drawing_a_triangle/01_Presentation/02_Image_views.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Image views
+
 To use any `VkImage`, including those in the swap chain, in the render pipeline we have to create a `VkImageView` object.
 An image view is quite literally a view into an image.
 It describes how to access the image and which part of the image to access, for example if it should be treated as a 2D texture depth texture without any mipmapping levels.
diff --git a/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/00_Introduction.adoc b/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/00_Introduction.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Introduction
+
 Over the course of the next few chapters we'll be setting up a graphics pipeline that is configured to draw our first triangle.
 The graphics pipeline is the sequence of operations that take the vertices and textures of your meshes all the way to the pixels in the render targets.
 A simplified overview is displayed below:
diff --git a/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/01_Shader_modules.adoc b/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/01_Shader_modules.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Shader modules
+
 Unlike earlier APIs, shader code in Vulkan has to be specified in a bytecode format as opposed to human-readable syntax like https://registry.khronos.org/OpenGL/specs/gl/GLSLangSpec.4.60.html[GLSL] and https://en.wikipedia.org/wiki/High-Level_Shading_Language[HLSL].
 This bytecode format is called https://www.khronos.org/spir[SPIR-V] and is designed to be used with both Vulkan and OpenCL (both Khronos APIs).
 It is a format that can be used to write graphics and compute shaders, but we will focus on shaders used in Vulkan's graphics pipelines in this tutorial.
diff --git a/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/02_Fixed_functions.adoc b/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/02_Fixed_functions.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Fixed functions
+
 The older graphics APIs provided default state for most of the stages of the graphics pipeline.
 In Vulkan you have to be explicit about most pipeline states as it'll be baked into an immutable pipeline state object.
 In this chapter we'll fill  in all of the structures to configure these fixed-function operations.
diff --git a/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.adoc b/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Render passes
+
 == Setup
 
 Before we can finish creating the pipeline, we need to tell Vulkan about the framebuffer attachments that will be used while rendering.
diff --git a/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/04_Conclusion.adoc b/en/03_Drawing_a_triangle/02_Graphics_pipeline_basics/04_Conclusion.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Conclusion
+
 We can now combine all of the structures and objects from the previous chapters to create the graphics pipeline!
 Here's the types of objects we have now, as a quick recap:
 
diff --git a/en/03_Drawing_a_triangle/03_Drawing/00_Framebuffers.adoc b/en/03_Drawing_a_triangle/03_Drawing/00_Framebuffers.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Framebuffers
+
 We've talked a lot about framebuffers in the past few chapters and we've set up the render pass to expect a single framebuffer with the same format as the swap chain images, but we haven't actually created any yet.
 
 The attachments specified during render pass creation are bound by wrapping them into a `VkFramebuffer` object.
diff --git a/en/03_Drawing_a_triangle/03_Drawing/01_Command_buffers.adoc b/en/03_Drawing_a_triangle/03_Drawing/01_Command_buffers.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Command Buffers
+
 Commands in Vulkan, like drawing operations and memory transfers, are not executed directly using function calls.
 You have to record all of the operations you want to perform in command buffer objects.
 The advantage of this is that when we are ready to tell the Vulkan what we want to do, all of the commands are submitted together and Vulkan can more efficiently process the commands since all of them are available together.
diff --git a/en/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.adoc b/en/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Rendering and presentation
+
 This is the chapter where everything is going to come together.
 We're going to write the `drawFrame` function that will be called from the main loop to put the triangle on the screen.
 Let's start by creating the function and call it from `mainLoop`:
diff --git a/en/03_Drawing_a_triangle/03_Drawing/03_Frames_in_flight.adoc b/en/03_Drawing_a_triangle/03_Drawing/03_Frames_in_flight.adoc
@@ -1,6 +1,6 @@
 :pp: {plus}{plus}
 
-== Frames in flight
+= Frames in flight
 
 Right now our render loop has one glaring flaw.
 We are required to wait on the previous frame to finish before we can start rendering the next which results in unnecessary idling of the host.
diff --git a/en/03_Drawing_a_triangle/04_Swap_chain_recreation.adoc b/en/03_Drawing_a_triangle/04_Swap_chain_recreation.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Swap chain recreation
+
 == Introduction
 
 The application we have now successfully draws a triangle, but there are some circumstances that it isn't handling properly yet.
diff --git a/en/04_Vertex_buffers/00_Vertex_input_description.adoc b/en/04_Vertex_buffers/00_Vertex_input_description.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Vertex input description
+
 == Introduction
 
 In the next few chapters, we're going to replace the hardcoded vertex data in the vertex shader with a vertex buffer in memory.
diff --git a/en/04_Vertex_buffers/01_Vertex_buffer_creation.adoc b/en/04_Vertex_buffers/01_Vertex_buffer_creation.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Vertex buffer creation
+
 == Introduction
 
 Buffers in Vulkan are regions of memory used for storing arbitrary data that can be read by the graphics card.
diff --git a/en/04_Vertex_buffers/02_Staging_buffer.adoc b/en/04_Vertex_buffers/02_Staging_buffer.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Staging buffer
+
 == Introduction
 
 The vertex buffer we have right now works correctly, but the memory type that allows us to access it from the CPU may not be the most optimal memory type for the graphics card itself to read from.
diff --git a/en/04_Vertex_buffers/03_Index_buffer.adoc b/en/04_Vertex_buffers/03_Index_buffer.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Index buffer
+
 == Introduction
 
 The 3D meshes you'll be rendering in a real world application will often share vertices between multiple triangles.
diff --git a/en/05_Uniform_buffers/00_Descriptor_set_layout_and_buffer.adoc b/en/05_Uniform_buffers/00_Descriptor_set_layout_and_buffer.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Descriptor layout and buffer
+
 == Introduction
 
 We're now able to pass arbitrary attributes to the vertex shader for each vertex, but what about global variables?
diff --git a/en/05_Uniform_buffers/01_Descriptor_pool_and_sets.adoc b/en/05_Uniform_buffers/01_Descriptor_pool_and_sets.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Descriptor pool and sets
+
 == Introduction
 
 The descriptor set layout from the previous chapter describes the type of descriptors that can be bound.
diff --git a/en/06_Texture_mapping/00_Images.adoc b/en/06_Texture_mapping/00_Images.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Images
+
 == Introduction
 
 The geometry has been colored using per-vertex colors so far, which is a rather limited approach.
diff --git a/en/06_Texture_mapping/01_Image_view_and_sampler.adoc b/en/06_Texture_mapping/01_Image_view_and_sampler.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Image view and sampler
+
 In this chapter we're going to create two more resources that are needed for the graphics pipeline to sample an image.
 The first resource is one that we've already seen before while working with the swap chain images, but the second one is new - it relates to how the shader will read texels from the image.
 
diff --git a/en/06_Texture_mapping/02_Combined_image_sampler.adoc b/en/06_Texture_mapping/02_Combined_image_sampler.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Combined image sampler
+
 == Introduction
 
 We looked at descriptors for the first time in the uniform buffers part of the tutorial.
diff --git a/en/07_Depth_buffering.adoc b/en/07_Depth_buffering.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Depth Buffering
+
 == Introduction
 
 The geometry we've worked with so far is projected into 3D, but it's still completely flat.
diff --git a/en/08_Loading_models.adoc b/en/08_Loading_models.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Loading Models
+
 == Introduction
 
 Your program is now ready to render textured 3D meshes, but the current geometry in the `vertices` and `indices` arrays is not very interesting yet.
diff --git a/en/09_Generating_Mipmaps.adoc b/en/09_Generating_Mipmaps.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Generating Mipmaps
+
 == Introduction
 
 Our program can now load and render 3D models.
diff --git a/en/10_Multisampling.adoc b/en/10_Multisampling.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Multisampling
+
 == Introduction
 
 Our program can now load multiple levels of detail for textures which fixes artifacts when rendering objects far away from the viewer.
diff --git a/en/11_Compute_Shader.adoc b/en/11_Compute_Shader.adoc
@@ -1,5 +1,7 @@
 :pp: {plus}{plus}
 
+= Compute Shader
+
 == Introduction
 
 In this bonus chapter we'll take a look at compute shaders.
diff --git a/en/90_FAQ.adoc b/en/90_FAQ.adoc
@@ -1,3 +1,5 @@
+= Frequently Asked Questions
+
 This page lists solutions to common problems that you may encounter while developing Vulkan applications.
 
 == I get an access violation error in the core validation layer

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+= Overview`
	`2`	`+`
`1`	`3`	`This chapter will start off with an introduction of Vulkan and the problems it addresses.`
`2`	`4`	`After that we're going to look at the ingredients that are required for the first triangle.`
`3`	`5`	`This will give you a big picture to place each of the subsequent chapters in.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+= Development Environment`
	`2`	`+`
`1`	`3`	`:pp: {plus}{plus}`
`2`	`4`
`3`	`5`	`In this chapter we'll set up your environment for developing Vulkan applications and install some useful libraries.`