Improve

Refactor

Refactor 0103

Refactor 3

Refactor 4

Refactor 5

Refactor 5

Author: Mysvac

.github/workflows/deploy.yml

@@ -31,7 +31,7 @@ jobs:
             ${{ runner.os }}-pip-
 
       - name: Install MkDocs and dependencies
-        run: pip install mkdocs-material pygments
+        run: pip install mkdocs-material
 
       - name: Build Docs
         run: mkdocs build --site-dir public

CMakeLists.txt

@@ -11,31 +11,34 @@ set(CMAKE_TOOLCHAIN_FILE "${VCPKG_CMAKE_PATH}/scripts/buildsystems/vcpkg.cmake")
 
 project(HelloVulkan LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD 23)
 
+#################################################################################
+#### Search for Vulkan package.
+# CMake provides FindVulkan support, but requires the VULKAN_SDK environment variable
+# Setting by default during Vulkan SDK installation, such as E: \ Vulkan \ 1.4.309.0
+find_package(Vulkan REQUIRED)
+#################################################################################
 
-include(cmake/VulkanHppModule.cmake)
-
+#################################################################################
+#### add_executable
+# Import third-party libraries through vcpkg
 find_package(glfw3 CONFIG REQUIRED)
 find_package(glm CONFIG REQUIRED)
 find_package(Stb REQUIRED)
 find_package(tinyobjloader CONFIG REQUIRED)
 
-file(GLOB_RECURSE MODULE_SOURCES src/*.cppm)
-
 # Add executable program targets
-add_executable( main src/main.cpp )
-target_sources( main PRIVATE
-        FILE_SET CXX_MODULES
-        FILES ${MODULE_SOURCES}
-)
-
-target_link_libraries(main PRIVATE VulkanHppModule )
-target_link_libraries(main PRIVATE glm::glm)
-target_link_libraries(main PRIVATE glfw )
-target_include_directories(main PRIVATE ${Stb_INCLUDE_DIR})
-target_link_libraries(main PRIVATE tinyobjloader::tinyobjloader)
+add_executable(${PROJECT_NAME} src/main.cpp)
 
-add_subdirectory(shaders)
+target_link_libraries(${PROJECT_NAME} PRIVATE Vulkan::Vulkan )
+target_link_libraries(${PROJECT_NAME} PRIVATE glm::glm )
+target_link_libraries(${PROJECT_NAME} PRIVATE glfw )
+target_include_directories(${PROJECT_NAME} PRIVATE ${Stb_INCLUDE_DIR})
+target_link_libraries(${PROJECT_NAME} PRIVATE tinyobjloader::tinyobjloader)
+#################################################################################
 
+#################################################################################
+#### shader compilation
+add_subdirectory(shaders)
+#################################################################################

CMakePresets.json

@@ -18,8 +18,8 @@
       }
     },
     {
-      "name": "win-x64",
-      "description": "Windows x64 config presets(MSVC + Ninja Multi-Config)",
+      "name": "win-msvc",
+      "description": "Windows x64 config (MSVC + Ninja Multi-Config)",
       "inherits": "ninja-base",
       "generator": "Ninja Multi-Config",
       "cacheVariables": {
@@ -37,6 +37,17 @@
         "rhs": "Windows"
       }
     },
+    {
+      "name": "win-clang",
+      "description": "Windows x64 config (Clang + MinGW + Ninja Multi-Config), not support STD Module",
+      "inherits": "win-msvc",
+      "generator": "Ninja Multi-Config",
+      "cacheVariables": {
+        "CMAKE_CONFIGURATION_TYPES": "Debug;Release",
+        "CMAKE_CXX_COMPILER": "clang++",
+        "CMAKE_C_COMPILER": "clang"
+      }
+    },
     {
       "name": "unix-gnu-debug",
       "description": "Linux/macOS GNU Debug config presets(GNU + Ninja)",
@@ -82,17 +93,31 @@
   ],
   "buildPresets": [
     {
-      "name": "win-x64-build-debug",
-      "displayName": "win-x64 Build Debug",
-      "description": "win-x64 build Debug preset",
-      "configurePreset": "win-x64",
+      "name": "win-msvc-build-debug",
+      "displayName": "win-msvc Build Debug",
+      "description": "win-msvc build Debug preset",
+      "configurePreset": "win-msvc",
+      "configuration": "Debug"
+    },
+    {
+      "name": "win-msvc-build-release",
+      "displayName": "win-msvc Build Release",
+      "description": "win-msvc build Release preset",
+      "configurePreset": "win-msvc",
+      "configuration": "Release"
+    },
+    {
+      "name": "win-clang-build-debug",
+      "displayName": "win-clang Build Debug",
+      "description": "win-clang build Debug preset",
+      "configurePreset": "win-clang",
       "configuration": "Debug"
     },
     {
-      "name": "win-x64-build-release",
-      "displayName": "win-x64 Build Release",
-      "description": "win-x64 build Release preset",
-      "configurePreset": "win-x64",
+      "name": "win-clang-build-release",
+      "displayName": "win-clang Build Release",
+      "description": "win-clang build Release preset",
+      "configurePreset": "win-clang",
       "configuration": "Release"
     },
     {

README.md

@@ -57,20 +57,18 @@
 
 ### 安装构建依赖
 
-项目使用 material-mkdocs 构建，还需要 pymdownx 扩展。请使用 pip 或 conda 安装下面的两个库：
+项目使用 material-mkdocs 构建，请使用 pip 或 conda 安装下面的两个库：
 
 pip:
 
 ```shell
 pip install mkdocs-material
-pip install pygments
 ```
 
 conda（请先选择并激活合适的虚拟环境）:
 
 ```shell
 conda install conda-forge::mkdocs-material
-conda install conda-forge::pygments
 ```
 
 ### 生成静态网页资源

docs/codes/00/01_env/CMakeLists.txt

@@ -11,7 +11,7 @@ set(CMAKE_TOOLCHAIN_FILE "${VCPKG_CMAKE_PATH}/scripts/buildsystems/vcpkg.cmake")
 
 project(HelloVulkan LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD 23)
 
 #################################################################################
 #### Search for Vulkan package. 

docs/codes/00/01_env/CMakePresets.json

@@ -18,8 +18,8 @@
       }
     },
     {
-      "name": "win-x64",
-      "description": "Windows x64 config presets(MSVC + Ninja Multi-Config)",
+      "name": "win-msvc",
+      "description": "Windows x64 config (MSVC + Ninja Multi-Config)",
       "inherits": "ninja-base",
       "generator": "Ninja Multi-Config",
       "cacheVariables": {
@@ -37,6 +37,17 @@
         "rhs": "Windows"
       }
     },
+    {
+      "name": "win-clang",
+      "description": "Windows x64 config (Clang + MinGW + Ninja Multi-Config), not support STD Module",
+      "inherits": "win-msvc",
+      "generator": "Ninja Multi-Config",
+      "cacheVariables": {
+        "CMAKE_CONFIGURATION_TYPES": "Debug;Release",
+        "CMAKE_CXX_COMPILER": "clang++",
+        "CMAKE_C_COMPILER": "clang"
+      }
+    },
     {
       "name": "unix-gnu-debug",
       "description": "Linux/macOS GNU Debug config presets(GNU + Ninja)",
@@ -82,17 +93,31 @@
   ],
   "buildPresets": [
     {
-      "name": "win-x64-build-debug",
-      "displayName": "win-x64 Build Debug",
-      "description": "win-x64 build Debug preset",
-      "configurePreset": "win-x64",
+      "name": "win-msvc-build-debug",
+      "displayName": "win-msvc Build Debug",
+      "description": "win-msvc build Debug preset",
+      "configurePreset": "win-msvc",
+      "configuration": "Debug"
+    },
+    {
+      "name": "win-msvc-build-release",
+      "displayName": "win-msvc Build Release",
+      "description": "win-msvc build Release preset",
+      "configurePreset": "win-msvc",
+      "configuration": "Release"
+    },
+    {
+      "name": "win-clang-build-debug",
+      "displayName": "win-clang Build Debug",
+      "description": "win-clang build Debug preset",
+      "configurePreset": "win-clang",
       "configuration": "Debug"
     },
     {
-      "name": "win-x64-build-release",
-      "displayName": "win-x64 Build Release",
-      "description": "win-x64 build Release preset",
-      "configurePreset": "win-x64",
+      "name": "win-clang-build-release",
+      "displayName": "win-clang Build Release",
+      "description": "win-clang build Release preset",
+      "configurePreset": "win-clang",
       "configuration": "Release"
     },
     {

docs/codes/00/01_env/main.cpp

@@ -1,36 +1,42 @@
 // main.cpp
+#include <iostream>
+#include <string_view>
+#include <print>
+
 #include <vulkan/vulkan.hpp>
 #include <vulkan/vulkan_raii.hpp>
+
 #include <GLFW/glfw3.h>
+
 #define GLM_FORCE_RADIANS
 #define GLM_FORCE_DEPTH_ZERO_TO_ONE
 #include <glm/vec4.hpp>
 #include <glm/mat4x4.hpp>
 
-#include <iostream>
-
 int main() {
-    glfwInit();
-
-    glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
-    GLFWwindow* window = glfwCreateWindow(800, 600, "Vulkan window", nullptr, nullptr);
-
-    uint32_t extensionCount = 0;
-    vkEnumerateInstanceExtensionProperties(nullptr, &extensionCount, nullptr);
+    // vulkan test
+    const vk::raii::Context context;
+    const auto extensions = context.enumerateInstanceExtensionProperties();
+    std::cout << "vulkan available extensions:" << std::endl;
+    for (const auto& extension : extensions) {
+        std::println("{}", std::string_view( extension.extensionName ));
+    }
 
-    std::cout << extensionCount << " extensions supported\n";
+    vk::raii::Semaphore semaphore( nullptr );
 
-    glm::mat4 matrix;
-    glm::vec4 vec;
-    auto test = matrix * vec;
+    // glm test
+    constexpr glm::mat4 matrix(1.0f);
+    constexpr glm::vec4 vec(1.0f, 2.0f, 3.0f, 4.0f);
+    constexpr glm::vec4 test = matrix * vec;
+    std::println("{} {} {} {}", test.x, test.y, test.z, test.w);
 
+    // glfw test
+    glfwInit();
+    glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
+    GLFWwindow* window = glfwCreateWindow(800, 600, "Vulkan window", nullptr, nullptr);
     while(!glfwWindowShouldClose(window)) {
         glfwPollEvents();
     }
-
     glfwDestroyWindow(window);
-
     glfwTerminate();
-
-    return 0;
-}
+}

docs/codes/01/00_base/CMakeLists.txt

@@ -11,7 +11,7 @@ set(CMAKE_TOOLCHAIN_FILE "${VCPKG_CMAKE_PATH}/scripts/buildsystems/vcpkg.cmake")
 
 project(HelloVulkan LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD 23)
 
 #################################################################################
 #### Search for Vulkan package. 

docs/codes/01/00_base/main.cpp

@@ -1,11 +1,17 @@
+#include <iostream>
+#include <print>
+#include <stdexcept>
+
 #include <vulkan/vulkan.hpp>
 #include <vulkan/vulkan_raii.hpp>
 #include <GLFW/glfw3.h>
 
-#include <iostream>
-#include <vector>
-#include <memory>
-#include <stdexcept>
+
+
+constexpr uint32_t WIDTH = 800;
+constexpr uint32_t HEIGHT = 600;
+
+
 
 class HelloTriangleApplication {
 public:
@@ -17,16 +23,10 @@ class HelloTriangleApplication {
     }
 
 private:
-    /////////////////////////////////////////////////////////////////
-    /// static values
-    static constexpr uint32_t WIDTH = 800;
-    static constexpr uint32_t HEIGHT = 600;
-    /////////////////////////////////////////////////////////////////
-
-    /////////////////////////////////////////////////////////////////
-    /// class member
+    /////////////////////////////////////////////////////////////
+    //// class member
     GLFWwindow* m_window{ nullptr };
-    /////////////////////////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////
 
     void initWindow() {
         glfwInit();
@@ -51,21 +51,17 @@ class HelloTriangleApplication {
         glfwDestroyWindow( m_window );
         glfwTerminate();
     }
-
-    
 };
 
 int main() {
-    HelloTriangleApplication app;
-
     try {
+        HelloTriangleApplication app;
         app.run();
-    } catch(const vk::SystemError & err ){
+    } catch(const vk::SystemError& err ) {
         // use err.code() to check err type
-        std::cout << "vk::SystemError: " << err.what() << std::endl;
-    } catch (const std::exception & err ){
-        std::cout << "std::exception: " << err.what() << std::endl;
+        std::println( std::cerr, "vk::SystemError - code: {} ",err.code().message());
+        std::println( std::cerr, "vk::SystemError - what: {}",err.what());
+    } catch (const std::exception& err ) {
+        std::println( std::cerr, "std::exception: {}", err.what());
     }
-
-    return 0;
 }