Rafx

Rafx是一个优先考虑性能、灵活性和生产力的多后端渲染器。它可选地集成了distill资产管道，为多学科团队合作的真实项目提供工作流程和工具。

此crate包含几个层

• rafx-api：低级图形API抽象
• rafx-visibility：低级保留API，用于确定可见性
• rafx-framework：中级框架，简化资源管理、生命周期处理和绘制调用调度
• rafx-assets：资产层，与distill集成
• rafx-renderer：一个具有插件系统的管道化渲染器
• rafx-plugins：许多基本和高级渲染技术和特性的实现

Rafx还提供了构建着色器和资产的工具。

文档

Amazon Lumberyard Bistro场景（原始资产：https://developer.nvidia.com/orca/amazon-lumberyard-bistro）

^ 在iOS硬件上运行此渲染器的视频

（瓦片地图截图是导入的ldtk项目文件）

当前支持

Rafx支持大多数主流平台。可以通过添加额外的后端来支持专有平台。

注意事项:

1. 某些后端/驱动程序/窗口管理器组合可能不起作用。最近在Ubuntu 20.04 LTS上进行了测试。
2. Android可能可以通过vulkan工作，但尚未进行测试。（可能可以使其工作）
3. 移动OpenGL设备可能可以工作，但可能需要改进以创建初始OpenGL图形上下文。
4. OpenGL ES 3.0 API的限制阻止了完整实现。主要演示在GL ES 2.0/3.0中无法完全工作。
5. OpenGL ES 3.0后端仍使用2.0路径进行某些功能。还有改进的空间！
6. OpenGL/WebGL将不会得到很多改进/支持。

请记住，此crate仍处于预0.1.0状态！

• 文档
• 对于rustdoc，请在crate的根目录下运行以下命令：cargo doc --no-deps --open（因为不使用特性构建，所以docs.rs是不完整的）

路线图

• rafx-api的API不太可能发生重大变化
• 其他高级crate正在根据演示改进和其他项目中进行的犬吠式测试进行重构/改进
• 对于近期未来，重点将放在以下方面
  • 框架的改进（可见性、多线程、API易用性）
  • 探索允许以模块化方式添加渲染功能的选择，使最终用户更容易共享他们的工作。
  • 完善现有后端并添加新后端
  • 扩展演示，添加更多渲染技术

该项目0.1.0版本发布后，该crate将遵循语义化版本控制规则。0.0.x版本不遵循语义化版本控制规则。

安全性

Rafx是不安全的，因为硬件加速渲染本质上是不安全的。然而，我们仅在操作可能由于与GPU交互之外的原因产生未定义行为时使用unsafe关键字。有关更多详细信息，请参阅以下文档

• https://github.com/aclysma/rafx/blob/master/docs/api/api_design.md#safety
• https://github.com/aclysma/rafx/blob/master/docs/api/safety.md

先决条件

CMake必须在您的路径上可用。它由演示中的SDL2和用于着色器管道的上游crate使用。

运行演示

应从存储库的演示目录中运行演示。以下命令将克隆repo并运行演示。

git clone https://github.com/aclysma/rafx.git
cd rafx
cd demo
cargo run --bin demo --release --features "[BACKEND_FEATURE]"

BACKEND_FEATURE可以是rafx-vulkan、rafx-metal或其他后端。

在发布模式下运行会减少日志并禁用GPU验证。第一次运行会慢一些，因为它需要导入资产，包括一个具有大纹理的GLTF网格。强烈建议使用配置文件覆盖来优化上游crate。在调试模式下，资产处理速度极慢。（即30秒而不是2秒）

演示功能

• 渲染线程与主线程解耦 (图)
• 着色器构建管道 (图)
• 离线纹理压缩和mipmap生成（通过basis-universal格式）
• 异步资产加载
• 可以将资产流式传输到远程硬件（例如手机）
• 或者可以将资产烹饪成二进制blob进行分发
• 热重新加载资产（需要更多工作，某些资产类型不可靠）
• 渲染图可用于高效和灵活地定义渲染管线，包括渲染到纹理、多个相机和计算着色器。
• 自动生成的着色器绑定使处理描述符集方便且错误率低。
• 支持多个渲染通道的材料系统
• 多相机支持（例如生成阴影图）
• 将演示游戏状态存储在ECS中（注意：演示使用legion，但渲染器是ECS无关的）
• PBR网格
• 精灵
• 调试绘制
• imgui/egui
• 具有阴影图缓存和100+阴影投射灯的聚类前向照明
• 具有泛光/Auto-exposure/TAA/SSAO/FidelityFX CAS的HDR管道
• HDR显示支持（仅在macOS上测试过，可能适用于vulkan）
• 点、聚光灯和方向光
• 多个聚光灯/方向光/点光软阴影
• 字体渲染
• LDTK瓦片图导入
• 对于2D或3D中的多个相机进行视锥剔除，在正交或透视投影中

工具

渲染器包括一些用于处理着色器和将数据打包到二进制blob中的工具。

还存在一个可用的搅拌机插件，但它仍在原型设计阶段，尚未进行文档化。

着色器处理器

此工具解析GLSL并生成对应的Rust代码。这使得使用描述符集更加容易和安全！

• 工具位于 /shader-processor
• 示例中包含一个 shaders 包，用于编译生成的Rust代码。它位于 /demo/shaders。只自动生成Rust代码，而不是Cargo.toml。
• 在示例中刷新着色器最简单的方法是点击该文件夹中的compile.bat或compile.sh。
• 您可以使用以下命令安装 cargo install rafx-shader-processor。请确保安装与您项目中包含的相同版本的插件。同时，别忘了在更新项目依赖项时更新它！

着色器处理器生成以下资产工件

• 特定于API的，例如编译后的SPIR-V或Metal源代码
• rafx在运行时使用的元数据
• 使处理着色器更容易的Rust代码
• 用于调试/检查的中间格式

着色器包可以作为资产加载，并包含加载编译后的着色器所需的一切。

打包资产

此工具目前仅用于打包资产。

• 按照以下方式打包文件： run --package cli -- --pack out.pack
• 按照以下方式运行示例： run --package demo -- --packfile out.pack
• 您可能需要为该工具创建一个从自己的main.rs生成的二进制文件。这样，您可以添加自己的资源类型。

Blender 插件

还有一个Blender插件实现了大关卡的工作流程，并导出了一种自定义格式，以避免重复共享资产数据。虽然它功能正常，但仍在早期实现阶段，尚未进行文档化。

• 导出：它自动导出纹理、材质、网格、模型（具有LOD级别的网格集合）和场景，以易于消费的格式，避免重复共享数据，并使用预定义的目录布局和导出设置。这使得导出工作流程简单且可靠。
• 关卡编辑：支持可以在团队环境中处理大型关卡的工作流程。关卡可以根据位置或功能进行切割并单独加载。这允许创建比DCC软件支持的更大的关卡，并允许更细粒度的文件签出，从而减少合并冲突。与大多数DCC文件格式不同，关卡和切片文件以文本格式存储，这使得它们可比较和可合并。

^ Blender中基于切片的关卡编辑视频

此视频展示了在Blender中加载了一个包含>5k对象、1M+顶点的场景，并在M1 mac mini上将其切割成多个较小的部分。

功能

• rafx-vulkan：使用Vulkan后端
• rafx-metal：使用Metal后端
• framework：包括并重新导出rafx crate中的rafx-framework
• assets：包括并重新导出rafx crate中的rafx-assets
• renderer：包括并重新导出rafx crate中的rafx-renderer

包

• rafx-base - 共享辅助器/数据结构。没什么特别的
• rafx-api - 渲染API抽象层。
  • Windows/Linux的Vulkan后端
  • macOS/iOS的Metal后端
• rafx-visibility - 保留可见性API。
  • 简单的基于句柄的抽象。
  • 快速、线程安全的可见性查询。
• rafx-framework - 资源管理，包括图像、缓冲区、描述符集等。
  • 大多数内容都进行了哈希和引用计数
  • 提供渲染图
  • 几乎所有资产都由可序列化和可哈希的结构驱动，而不是硬编码。
  • 当可用时，缓冲区和图像将异步上传到专用传输队列
  • 多遍材料抽象，具有可绑定参数
  • 渲染功能和作业系统 - 受2015年GDC演讲“Destiny的多线程渲染架构”的启发。
    • 具有提取、准备和写入阶段的作业系统
    • 渲染通过模拟线程进行管道化，作业结构可以通过应用程序并行化
    • 处理多个视图和阶段，允许像阴影映射这样的高级功能
    • 灵活的排序机制，用于交错和批量写入来自多个渲染功能的命令
  • 可见区域 - 基于 rafx-visibility
    • 高级可见性API，与框架渲染作业集成
• rafx-assets - 资产加载和管理系统。
  • 资产可以从文件热重载（但请参阅 #14）
  • 由于distill在更改时预处理并存储缓存的资产，因此可以在保持极快的加载速度的同时实现自定义处理/打包。例如，纹理压缩可以作为一个导入步骤实现。
  • 为运行时创建资产提供单独的多线程友好路径
• rafx-renderer - 带有插件系统以自定义它的管道化渲染器

常见问题解答

问题：为什么我会从bincode序列化程序中收到神秘的崩溃

答案：资产通过serde导入并序列化为bincode。如果这些结构中的任何一个被修改，则需要重新导入资产。正确的修复方法是增加导入程序的版本号，这将强制重新导入受影响的资产。但是删除 .assets_db 是一个简单的修复。一般来说，为了避免这种情况，我们应该在没有增加导入程序版本号的情况下不要提交这些结构的修改。

许可证

根据您的选择，许可如下

• Apache License，版本 2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

。

上游依赖项

demo/fonts目录包含几个字体，它们根据各自的许可证进行许可

• Feather，MIT
• Material Design Icons，SIL OFL 1.1
• FontAwesome 4.7.0，可在SIL OFL 1.1下使用
• mplus-1p-regular.ttf，可在其自身许可证下使用。

assets/blender目录包含来自 https://freepbr.com 的某些着色器，可在其自身许可证下使用

天空盒来自

• https://opengameart.org/content/space-skyboxes-0 (CC0)
• http://www.humus.name/index.php?page=Textures (CC BY 3.0)

assets/ldtk 包含来自 LDTK 级别编辑器的示例数据（MIT）

• 瓦片地图来自 https://ansimuz.itch.io/sunny-land-pixel-game-art (CC0)

某些依赖项可能根据其他条款进行许可。这些许可证包括 "ISC"、"CC0-1.0"、"BSD-2-Clause"、"BSD-3-Clause" 和 "Zlib"。这些许可证在每个CI运行中通过 cargo-deny 进行最佳努力验证。

致谢

Rafx 从许多优秀想法和项目中受益！

贡献

除非您明确表示，否则您提交的任何有意包含在作品中的贡献，如Apache-2.0许可证中定义的，应如上双重许可，不得附加任何其他条款或条件。

请参阅LICENSE-APACHE和LICENSE-MIT。