VXR 引擎使用教程

1. 项目介绍

VXR 是一个用 C++ 编写的通用渲染引擎，特别强调材质渲染（PBR、清漆、各向异性、虹彩）。该项目源于构建一个通用渲染工具的愿望，可以用来实现任何感兴趣或想学习的内容。目前，它是一个多线程的 3D 游戏开发引擎，支持不同的渲染后端。

VXR 引擎有两个不同的 API 用于开发：

• 一个基于渲染显示列表命令的低级 API，可用于构建小型但高效的应用程序。
• 一个构建在低级 API 之上的高级 API，它抽象了底层 API，提供了一个渲染无关和组件导向的 API。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下工具：

• Visual Studio 2017 或更高版本
• CMake

2.2 克隆项目

首先，克隆 VXR 项目到本地：

git clone https://github.com/avilapa/vxr.git
cd vxr

2.3 生成解决方案

使用 GENie 生成 Visual Studio 解决方案：

cd project
..\tools\genie vs2017

生成的解决方案文件将位于 project/vs/VXR-Engine.sln。

2.4 编译项目

打开生成的解决方案文件 VXR-Engine.sln，在 Visual Studio 中编译项目。

2.5 运行示例项目

编译完成后，可以在解决方案中找到提供的示例项目，例如 01-HelloWorld。运行这些示例项目以查看引擎的功能。

3. 应用案例和最佳实践

3.1 创建新项目

要创建一个新的项目，可以在 project/genie.lua 文件的末尾添加以下代码：

makeProject("yourProjectName")

然后重新生成解决方案并编译。

3.2 使用参数构建

在生成解决方案时，可以使用以下参数来定制构建：

..\tools\genie --gl --debug_tracing vs2017

参数说明：

• --gl: 使用 OpenGL 后端
• --debug_tracing: 使用 minitrace 并启用 trace.json 文件创建
• --no-console: 不启动图形窗口的控制台
• --no-threading: 在逻辑线程上启动渲染，不进行异步加载任务
• --no-ui: 禁用所有 UI（仍会编译 ImGui）

4. 典型生态项目

VXR 引擎可以与其他开源项目结合使用，例如：

• GLFW: 用于窗口管理和输入处理。
• ImGui: 用于创建用户界面。
• TinyObjLoader: 用于加载 .obj 模型文件。

这些项目可以与 VXR 引擎无缝集成，提供更丰富的功能和更好的开发体验。

---

通过以上步骤，你可以快速启动并开始使用 VXR 引擎进行开发。希望这篇教程对你有所帮助！