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和avk::orbit_camera （源自avk::transform and 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 ），然后生成新的！