Refactor Vulkan tutorial for RAII and modern Vulkan practices

Updated code and documentation to align with modern Vulkan best practices:
- Adopted RAII wrappers for better resource management and type safety.
- Introduced structured initialization for clarity and consistency.
- Improved tutorial content with grammatical fixes, terminology updates, and modernization of examples.
- Rephrased sections for better readability and alignment with Vulkan 1.3+ features.

Author: gpx1000

attachments/05_window_surface.cpp

@@ -173,7 +173,7 @@ class HelloTriangleApplication {
         // first check if the graphicsIndex is good enough
         auto presentIndex = physicalDevice.getSurfaceSupportKHR( graphicsIndex, *surface )
                                            ? graphicsIndex
-                                           : static_cast<uint32_t>( queueFamilyProperties.size() );
+                                           : ~0 );
         if ( presentIndex == queueFamilyProperties.size() )
         {
             // the graphicsIndex doesn't support present -> look for another family index that supports both

attachments/06_swap_chain_creation.cpp

@@ -260,12 +260,7 @@ class HelloTriangleApplication {
     }
 
     static vk::PresentModeKHR chooseSwapPresentMode(const std::vector<vk::PresentModeKHR>& availablePresentModes) {
-        for (const auto& availablePresentMode : availablePresentModes) {
-            if (availablePresentMode == vk::PresentModeKHR::eMailbox) {
-                return availablePresentMode;
-            }
-        }
-        return vk::PresentModeKHR::eFifo;
+        return std::ranges::contains( presentModes, vk::PresentModeKHR::eMailbox ) ? vk::PresentModeKHR::eMailbox : vk::PresentModeKHR::eFifo;
     }
 
     vk::Extent2D chooseSwapExtent(const vk::SurfaceCapabilitiesKHR& capabilities) {

attachments/07_image_views.cpp

@@ -227,9 +227,13 @@ class HelloTriangleApplication {
         // create a Device
         float                     queuePriority = 0.0f;
         vk::DeviceQueueCreateInfo deviceQueueCreateInfo { .queueFamilyIndex = graphicsIndex, .queueCount = 1, .pQueuePriorities = &queuePriority };
-        vk::DeviceCreateInfo      deviceCreateInfo{ .pNext =  &features, .queueCreateInfoCount = 1, .pQueueCreateInfos = &deviceQueueCreateInfo };
-        deviceCreateInfo.enabledExtensionCount = deviceExtensions.size();
-        deviceCreateInfo.ppEnabledExtensionNames = deviceExtensions.data();
+        vk::DeviceCreateInfo      deviceCreateInfo{
+            .pNext =  &features,
+            .queueCreateInfoCount = 1,
+            .pQueueCreateInfos = &deviceQueueCreateInfo
+            .enabledExtensionCount = deviceExtensions.size();
+            .ppEnabledExtensionNames = deviceExtensions.data();
+         };
 
         device = vk::raii::Device( physicalDevice, deviceCreateInfo );
         graphicsQueue = vk::raii::Queue( device, graphicsIndex, 0 );

attachments/21_index_buffer.cpp

@@ -507,7 +507,7 @@ class HelloTriangleApplication {
         commandBuffers[currentFrame].setViewport(0, vk::Viewport(0.0f, 0.0f, static_cast<float>(swapChainExtent.width), static_cast<float>(swapChainExtent.height), 0.0f, 1.0f));
         commandBuffers[currentFrame].setScissor( 0, vk::Rect2D( vk::Offset2D( 0, 0 ), swapChainExtent ) );
         commandBuffers[currentFrame].bindVertexBuffers(0, *vertexBuffer, {0});
-        commandBuffers[currentFrame].bindIndexBuffer( *indexBuffer, 0, vk::IndexType::eUint16 );
+        commandBuffers[currentFrame].bindIndexBuffer( *indexBuffer, 0, vk::IndexTypeValue<decltype(indices)::value_type>::value );
         commandBuffers[currentFrame].drawIndexed(indices.size(), 1, 0, 0, 0);
         commandBuffers[currentFrame].endRendering();
         // After rendering, transition the swapchain image to PRESENT_SRC
@@ -698,4 +698,4 @@ int main() {
     }
 
     return EXIT_SUCCESS;
-}
+}

attachments/24_texture_image.cpp

@@ -444,7 +444,7 @@ class HelloTriangleApplication {
     void createTextureImage() {
         int texWidth, texHeight, texChannels;
         stbi_uc* pixels = stbi_load("textures/texture.jpg", &texWidth, &texHeight, &texChannels, STBI_rgb_alpha);
-        VkDeviceSize imageSize = texWidth * texHeight * 4;
+        vk::DeviceSize imageSize = texWidth * texHeight * 4;
 
         if (!pixels) {
             throw std::runtime_error("failed to load texture image!");

attachments/25_sampler.cpp

@@ -448,7 +448,7 @@ class HelloTriangleApplication {
     void createTextureImage() {
         int texWidth, texHeight, texChannels;
         stbi_uc* pixels = stbi_load("textures/texture.jpg", &texWidth, &texHeight, &texChannels, STBI_rgb_alpha);
-        VkDeviceSize imageSize = texWidth * texHeight * 4;
+        vk::DeviceSize imageSize = texWidth * texHeight * 4;
 
         if (!pixels) {
             throw std::runtime_error("failed to load texture image!");

attachments/26_shader_textures.slang

@@ -14,15 +14,13 @@ ConstantBuffer<UniformBuffer> ubo;
 struct VSOutput
 {
     float4 pos : SV_Position;
-    float3 fragColor;
     float2 fragTexCoord;
 };
 
 [shader("vertex")]
 VSOutput vertMain(VSInput input) {
     VSOutput output;
     output.pos = mul(ubo.proj, mul(ubo.view, mul(ubo.model, float4(input.inPosition, 0.0, 1.0))));
-    output.fragColor = input.inColor;
     output.fragTexCoord = input.inTexCoord;
     return output;
 }

attachments/27_depth_buffering.cpp

@@ -512,18 +512,16 @@ class HelloTriangleApplication {
     }
 
     vk::Format findSupportedFormat(const std::vector<vk::Format>& candidates, vk::ImageTiling tiling, vk::FormatFeatureFlags features) {
-        for (const auto format : candidates) {
-            vk::FormatProperties props = physicalDevice.getFormatProperties(format);
-
-            if (tiling == vk::ImageTiling::eLinear && (props.linearTilingFeatures & features) == features) {
-                return format;
-            }
-            if (tiling == vk::ImageTiling::eOptimal && (props.optimalTilingFeatures & features) == features) {
-                return format;
-            }
+        auto formatIt = std::ranges::find_if(candidates, [&physicalDevice, &tiling, &features](auto const format){
+            vk::FormatProperties props = physicalDevice->getFormatProperties(format);
+            return (((tiling == vk::ImageTiling::eLinear) && ((props.linearTilingFeatures & features) == features)) ||
+                    ((tiling == vk::ImageTiling::eOptimal) && ((props.optimalTilingFeatures & features) == features)));
+        });
+        if ( formatIt == candidates.end())
+        {
+            throw std::runtime_error("failed to find supported format!");
         }
-
-        throw std::runtime_error("failed to find supported format!");
+        return *formatIt;
     }
 
     vk::Format findDepthFormat() {
@@ -1000,7 +998,8 @@ class HelloTriangleApplication {
     }
 
     static vk::Format chooseSwapSurfaceFormat(const std::vector<vk::SurfaceFormatKHR>& availableFormats) {
-        return (availableFormats[0].format == vk::Format::eUndefined) ? vk::Format::eB8G8R8A8Unorm : availableFormats[0].format;
+        auto formatIt = std::ranges::find(availableFormats, vk::SurfaceFormatKHR(vk::Format::eB8G8R8A8Srgb, vk::ColorSpaceKHR::eSrgbNonlinear));
+        return (formatIt != availableFormats.end() ? *formatIt : availableFormats[0];
     }
 
     static vk::PresentModeKHR chooseSwapPresentMode(const std::vector<vk::PresentModeKHR>& availablePresentModes) {

attachments/31_compute_shader.cpp

@@ -410,8 +410,6 @@ class ComputeShaderApplication {
         vk::raii::ShaderModule fragShaderModule = createShaderModule(readFile("shaders/frag.spv"));
         vk::raii::ShaderModule shaderModule = createShaderModule(readFile("shaders/slang.spv"));
 
-        // vk::PipelineShaderStageCreateInfo vertShaderStageInfo({}, vk::ShaderStageFlagBits::eVertex, vertShaderModule, "main");
-        // vk::PipelineShaderStageCreateInfo fragShaderStageInfo({}, vk::ShaderStageFlagBits::eFragment, fragShaderModule, "main");
         vk::PipelineShaderStageCreateInfo vertShaderStageInfo{ .stage = vk::ShaderStageFlagBits::eVertex, .module = shaderModule, .pName = "vertMain" };
         vk::PipelineShaderStageCreateInfo fragShaderStageInfo{ .stage = vk::ShaderStageFlagBits::eFragment, .module = shaderModule, .pName = "fragMain" };
         vk::PipelineShaderStageCreateInfo shaderStages[] = {vertShaderStageInfo, fragShaderStageInfo};

en/00_Introduction.adoc

@@ -4,15 +4,15 @@
 
 == Attribution
 
-The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial .com/[Vulkan Tutorial]" by Alexander Overvoorde licensed under
+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 tutorial will teach you the basics of using the
 https://www.khronos.org/vulkan/[Vulkan] graphics and compute API.
-Vulkan is a new API by the https://www.khronos.org/[Khronos group] (known
-for OpenGL) that provides a much better abstraction of modern graphics cards.
+Vulkan is an API by the https://www.khronos.org/[Khronos group] that
+provides a much better abstraction of modern graphics cards.
 This new interface allows you to better describe what your application
 intends to do, which can lead to better performance and less surprising
 driver behavior compared to existing APIs like
@@ -82,10 +82,6 @@ different linear algebra library, and you will be on your own in terms of
   code structuring.
 We will use C{pp} features like classes and RAII to organize logic and
  resource lifetimes.
-There are also two alternative versions of this tutorial available for Rust
- developers:
-https://github.com/bwasty/vulkan-tutorial-rs[Vulkano based],
-https://kylemayes.github.io/vulkanalia[Vulkanalia based].
 
 To make it easier to learn to work with Vulkan, we'll be using the newer
 https://github.com/KhronosGroup/Vulkan-Hpp[Vulkan-Hpp] bindings that
@@ -133,8 +129,6 @@ certain Vulkan feature.
 That means that the site is also useful as a reference.
 All the Vulkan functions and types are linked to the specification, so you
 can click them to learn more.
-Vulkan is a very new API, so there may be some shortcomings in the
-specification itself.
 You are encouraged to submit feedback to https://github
 .com/KhronosGroup/Vulkan-Docs[this Khronos repository].