Auto Vk Toolkit

自動VK-Toolkit v1.0

Auto-VK-ToolKit是現代C ++實現的Vulkan Graphics API的框架。它的目的是在程序員企業和效率之間達到最佳位置，同時仍支持完整的Vulkan功能。為了實現這一目標，該框架使用了自動VK ，這是Vulkan-HPP頂部的便利性和生產力層。

自動VK-toolkit已成功用於快速原型製作，研究（例如，保守的網狀網絡界限，用於穩健的皮膚網格，現代GPU上的參數對象的快速渲染）和教學（例如，實時渲染的算法，算法）。

該圖像展示了使用自動VK-Toolkit （從左到右）開發的一些工作：在教授現代低級GPU概念的高級圖形課程中使用；從腦掃描中可視化19,600個球形諧波字形；將網眼分為圓環，並在任務和網格著色器中使用細粒度的視圖和背面剔除；射線使用硬件加速的實時射線跟踪設備擴展來追踪陰影和反射；實時渲染358K參數定義的纖維曲線。

它的一些高光功能（除了自動VK的出色功能）還包括：

• 通過GLFW進行窗口管理和輸入處理。
• 使用update()和render()回調在不同或固定更新時間的渲染循環框架。
• 功能強大的Auto -VK avk::root實現，以及交換鏈的處理和自動資源壽命管理。
• 多功能更新器，可實現Swapchain娛樂。
• 結合功能強大的郵政輔助工具（僅限Windows），更新機可以使著色器熱加載。
• 在Assimp的幫助下，各種3D場景的型號加載。
• 從ORCA加載.fscene文件：開放研究內容檔案。
• 加載多種圖像格式，包括立方體圖。
• 多功能序列化器支持允許序列化vulkan資源，例如avk:buffer或avk::image Instances，以及自定義類型；基於穀物。
• 通過IMGUI的用戶界面支持，並支持在UI中顯示紋理。
• 支持實時射線追踪（RTX）和從三角形網眼或AABBS的加速結構方便建造。
• 支持將網格分為可以用任務和網格著色器渲染的網格。
• 處理骨骼等級，支持皮膚網眼的動畫。

目錄

• 安裝
  • Visual Studio 2022
    • 要求
    • 設置並構建指令
    • 設置自己的項目
  • cmake
• 例子
• 創建一個新項目
• 資源管理和郵政為助手
• 自動VK-ToolKit和Auto-VK有什麼區別？
• 文件
• 常見問題解答，已知問題，故障排除

安裝

Auto-VK-ToolKit已準備好與Visual Studio或Cmake一起使用。如果您的系統符合系統要求，則設置了所有設置，以建立開箱即用的運行。例如，對於Visual Studio，打開visual_studio/auto_vk_toolkit.sln ，將示例項目之一設置為啟動項目，構建和運行！

提示：開發分支機構上的版本可能是更新的，並包含其他功能和修復程序。請考慮使用該版本，尤其是在遇到問題的情況下。

注意：在第一次運行時，正在構建郵政輔助工具。觀看Visual Studio的“輸出”選項卡以獲取狀態消息和可能的說明。

Visual Studio 2022

Windows上的Visual Studio 2022提供了預先配置的項目設置。

要求

• Windows 10或11
• Visual Studio 2022安裝了Windows 10或11 SDK（有關項目設置和資源管理的詳細信息，請參閱visual_studio/README.md 。）
• 來自Lunarg的Vulkan 1.3 SDK，最佳Vulkan SDK 1.3.250.0或更新。

設置並構建指令

• 克隆或下載此存儲庫
• 執行git submodule update --init以拉動自動VK框架，該框架在auto_vk下添加為子模塊
• 下載並安裝Windows最新的Vulkan SDK之一！
  • 選擇Vulkan Memory Allocator header.選項，以便安裝Vulkan內存分配器（VMA）庫。
  • 注意：通過選擇Vulkan Memory Allocator header.可以通過Vulkan Installer或其維護工具（例如，Windows上的maintenancetool.exe ）安裝VMA。選項。
• 下載並安裝Visual Studio Community 2022或更新版本。
  • 在安裝程序中選擇Desktop development with C++ ！
• 推薦：安裝GLSL語言集成擴展程序，以在著色器文件中突出顯示語法！
  • 提示：轉到Tools -> Options -> GLSL language integration 。對於Vulkan著色器開發，要么將Live compiling設置為False （語法突出顯示），要么將External compiler executable file設置為glslangValidator.exe的路徑！
• 打開Visual Studio解決方案文件visual_studio/auto_vk_toolkit.sln ，並構建解決方案
• 在構建過程中，您將在Visual Studio的Output -TAB，一些彈出消息和系統托盤中的圖標中識別出郵寄輔助工具的消息。請查看部分資源管理和郵政為助手以獲取更多信息。
• 解決方案文件中有幾個示例應用程序可用。將其中一個設置為啟動項目，然後運行。

設置自己的項目

• 要將Auto-VK-ToolKit添加到您的一個自定義存儲庫中，您可能需要將其添加為GIT子模塊。您可以執行git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit將auto-vk-toolkit添加為Directory auto_vk_toolkit中的subpodule。
• 執行git submodule update --init --recursive ，以便提取Auto-VK-ToolKit和Auto-VK 。
• 創建新項目的部分中描述的步驟可能有助於建立一個鏈接自動VK-Toolkit的自定義Visual Studio項目。
• 設置自己的項目的最方便方法可能是啟動模板之一：
  • 基於視覺工作室項目的入門模板：自動VK-Toolkit-VS-Starter
  • 基於CMAKE的項目的入門模板：Auto-VK-ToolKit-Starter

cmake

請參閱文檔/cmake.md！

例子

你好世界	多個隊列	計算圖像處理	逆裝加載程序

此存儲庫中包括幾個示例應用程序：

• 你好世界：如何渲染一個三角形
• 頂點緩衝區：如何將頂點緩衝區與圖形管道使用
• FrameBuffer：如何創建和使用Framebuffer
• 多數調用渲染：如何使用多個調用，如何構造應用程序
• 多個QEUE：如何使用多個隊列（兩個傳輸和一個圖形隊列）
• 計算圖像處理：如何使用計算著色器進行某些圖像處理
• 從計算中出現：如何從計算隊列出現到交換鏈
• 模型加載器：如何從文件加載3D模型並渲染它們
• Orca Loader：如何加載orca .fscene文件並渲染它們；還有如何使用序列化器
• 靜態網眼：如何將3D模型分為小網眼並使用任務和網狀著色器渲染
• 皮膚的網格：如何將動畫，皮膚的3D型號分為小網眼，以及如何使用任務和網格著色器進行動畫和渲染該動畫和渲染
• 用陰影和AO追踪射線：如何從三角形網絡構建加速結構並創建射線跟踪的圖像。此外，還增加了射線跟踪的陰影和非常簡單的（醜陋）的環境阻塞，從而通過遞歸射線從最接近的命中著色器中跟踪遞歸射線。
• 射線追踪著色器中的射線查詢：類似於“帶陰影和AO”示例的“射線跟踪”，但是它沒有使用遞歸的射線跟踪著著色器綁定表等。它只是使用來自最接近的命中式著色器的射線查詢來實現相同的結果。
• 射線追踪自定義交叉點：如何從AABB和三角形網格中構建加速結構。
• 紋理Cubemap：如何加載和使用立方體圖。

皮膚的網格	雷查詢和射線追踪	RTX自定義交叉點	紋理cubemap

創建一個新項目

對於Visual Studio Projects，在visual_studio/tools/executables/下有一個便利工具，可以通過複製現有一個來幫助快速設置新項目（例如，示例應用程序之一）： create_new_project.exe

像以下內容一樣使用它來創建現有項目的副本：

• 打開create_new_project.exe ，然後選擇示例應用程序之一，或輸入要手動複製項目的路徑。
• 輸入目標位置，目標項目名稱，然後擊中[創建它！] -button。
• 該項目已復製到目標文件夾，如果目標文件夾與源項目相同的驅動器，則所有相對路徑都適用於新位置。 （如果不是，則設置了絕對路徑。）
• 保留資產參考和著色器參考，並適應其路徑。
  注意：如果要修改引用的資產/著色器，請確保刪除現有的參考文獻！您必須手動創建這些文件的副本，然後將引用添加到副本中。如果您不這樣做，您最終會修改股票資產或示例的著色器文件。
• 在新創建的項目副本中禁用預編譯標題。如果您想使用此功能，則必須在Visual Studio的項目設置中手動啟用它。
• 手動向您的Visual Studio解決方案手動向Auto-VK-ToolKit庫項目auto_vk_toolkit.vxcproj添加引用，並確保新創建的項目複製參考。
• 所有源和包含的文件參考將從新創建的項目副本中刪除。您必須至少添加一個包含main()函數的.cpp文件。
• 添加#include <auto_vk_toolkit.hpp>使用auto-vk-toolkit 。
• 在這些步驟之後，您應該能夠成功地鏈接到自動VK-Toolkit構建新創建的項目。

一個好的策略是將自動VK-ToolKit作為GIT子模塊添加到您的存儲庫中，並使用create_new_project.exe和上面的步驟在子模塊外部的目錄中創建一個正確配置的項目。確保通過從Auto-VK-Toolkit的master分支中拉出以獲取最新更新來經常更新子模塊。

資源管理和郵政為助手

配置了自動VK-Toolkit的Visual Studio項目，因此Visual Studio本身可以優雅地用於資源管理。這意味著，所需的資產（3D模型，圖像，Orca場景文件）和著色器文件只能在“解決方案資源管理器”視圖中添加到Visual Studio的過濾器中，並且智能郵政構建助手工具可確保將這些資源部署到應用程序的目標目錄中。

簡而言/ tl; dr ：

• 將所需的3D型號，圖像和Orca場景添加到assets過濾器中，然後
• 將所需的著色器文件添加到Visual Studio中的shaders過濾器中。然後構建應用程序，等待郵政輔助人員將這些資源部署到目標目錄，然後運行您的應用程序！

如上所述shaders這看起來就像以下是如下assets ：

visual_studio/README.md中給出了更詳細的說明和進一步的說明。

您會注意到通過其托盤圖標構建助手活動： 。部署完成後，該工具將保持活躍，原因有兩個：

• 它允許研究以前的構建事件中的日誌，並更改設置。
• 它繼續監視資源文件，這對於啟用著色器熱加載特別重要。

有關帖子構建助手的更多信息，請參閱“郵政為輔助助手”部分，以及有關Shinder Hot ReloDoding的更多信息，請參閱下面的“自動資源更高”部分。

自動VK-ToolKit和Auto-VK有什麼區別？

Auto-VK是Vulkan-HPP頂部的平台不足的便利性和生產力層。

Auto-VK-ToolKit建立了丟失的操作系統鏈接，例如窗口處理，並添加了進一步的功能：

• 渲染環境配置，例如啟用VULKAN擴展（例如，如果使用VK_KHR_ray_tracing_pipeline ，它將選擇一個適當的物理設備並啟用所需的標誌和擴展））
• 窗口管理（通過GLFW）
• 遊戲環/渲染環處理方便地使用avk::invokee接口（例如initialize() ， update() ，under（）， render() ，其中前一個被稱為一次，並且後兩個被調用，每個幀僅調用後兩個）
• 用戶輸入處理
• 準備將基類用於對象層次結構： avk::transform
• 準備使用用戶控制的相機類avk::quake_camera Quake_camera和Avk avk::orbit_camera （源自avk::transform Transform and Avk avk::invokee ）
• 資源加載支持：
  • 圖像
  • 3D型號
  • 逆戟鯨格式的場景，請參閱：ORCA：開放研究內容檔案
• 材料加載和轉換為gpu適合格式（ avk::material和a vk::material_gpu_data ）
• Lightsource加載和轉換為GPU適合格式（ avk::lightsource和avk::lightsource_gpu_data ）
• 通過Visual Studio的過濾器進行資源處理，即您只想將其直接使用到Visual Studio的過濾器層次結構中並將其部署到目標目錄中的拖放資產和著色器。
• 一個強大的郵政輔助工具，被稱為自定義構建步驟。
  • 它將資產和著色器部署到目標目錄
  • 著色器被編譯為Spir-V
  • 如果著色器文件包含錯誤，則創建彈出消息以顯示錯誤，並提供一個[->VS]按鈕以導航到在Visual Studio中包含錯誤的行。
  • 默認情況下，“調試”和“ Release”構建配置SYMLINK資源以節省空間，但“發布”構建配置將所有必需的文件部署到目標目錄中，以便可以輕鬆地將構建程序傳輸到另一個PC。在這種情況下，不再需要收集繁瑣的資源，因為這一切都由郵政輔助人員處理。

文件

有一些文檔頁麵包含更多信息：

• 用戶界面的使用IMGUI，描述瞭如何在Auto-VK-ToolKit項目中使用Dear Imgui
• CMAKE設置並構建指令
• 將幾何形狀分為小群集並使用它們在圖形網狀管道（具有任務和網格著色器的那些）中渲染的網格特定功能
• 用於存儲和從文件中存儲和加載資源的串行器功能，例如3D模型，圖像或自定義結構
• 通過avk::updater類自動更新，啟用shwapchain娛樂和著色器熱加載
• 動態渲染：如何在Auto-VK-Toolkit中使用動態渲染

常見問題解答，已知問題，故障排除

問：可以在Linux上使用自動VK-ToolKit嗎？
答：是的。請在Docs/cmake.md上查看CMAKE文檔！

問：可以在沒有郵政輔助器的情況下使用自動VK-Toolkit ？
答：是的。帖子構建助手是一個方便工具，可處理資源部署，資產依賴性以及文件更新（根據項目結構，可用於著色器熱加載）。如果您不使用它，則必須管理資源的部署，並將其編譯到Spir-V中。

問：我在Visual Studio中對資產管理有麻煩。有建議嗎？
答：查看已知問題並進行故障排除WRT資產處理，該處理提供了以下情況的指南：

• 添加資產時構建錯誤
• 資產沒有部署，因為它沒有保存在Visual Studio的過濾器文件中

問：部署的資源比我在Visual Studio過濾器中添加的資源更多。這是怎麼回事？
答：一些資產在內部引用其他資產。例如，3D模型通常參考圖像或材料文件（如果是.obj型號）。這些“依賴資產”也由郵政輔助人員部署到目標目錄。有關更多詳細信息，請參閱依賴資產的部署。

問：調試，發布和發布構建配置之間有什麼區別？
答：在編譯設置方面，發布和發布配置是相同的。它們與庫的發布構建有關。調試配置具有為Visual Studio項目配置的經典調試設置以及針對庫的調試構建的鏈接。但是，發布構建與非發布構建之間存在差異。有關更多詳細信息，請根據構建配置查看符號鏈接/副本。

問：我對郵政輔助人員有麻煩。該怎麼辦？
答：查看郵政構建助手，該輔助人員為以下情況提供指南：

• 構建被困在“要調用[...] msbuild.exe”步驟中，顯示在Visual Studio的輸出選項卡中
• 郵政構建助手不能自動/通過msbuild.exe構建
• 部署的資源太少
• 應用程序無法首先嘗試（也許是由於缺少資產或DLL）
• 有關拒絕訪問DLL文件的錯誤消息（未重新部署DLL）
• 在郵政構建助手中顯示列表時的性能緩慢
• 郵政構建助手的UI中的錯誤消息：“找不到路徑的一部分'...'”
• 控制台中的錯誤消息： can't fopen或!RUNTIME ERROR! Couldn't load image from '...'

問：應用程序需要很長時間才能加載3D型號和圖像之類的資產。可以加速嗎？
答：如果您指的是調試構建，則可以配置Post Build Helper ，以便它可以部署某些外部依賴的釋放DLL，即使是用於調試構建。他們應該加速資產加載很多。要啟用發行版DLL的部署，請打開Post Build Build Helper的設置，並啟用“始終部署釋放dlls”選項。

問：在穀物中獲取cereal::Exception cereal::loadBinary或Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
答：您的序列化緩存文件（例如，對於sponza_and_terrain.fscene ，可以是sponza_and_terrain.fscene.cache ）已損壞（也許是因為由於該應用程序中的錯誤未完全編寫，或者因為執行的執行被刪除而被刪除）。刪除緩存文件（例如sponza_and_terrain.fscene.cache ），然後生成新的！