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是不安全的，因为硬件加速渲染本质上是不安全的。然而，我们保留使用unsafe关键字的情况，当操作可以产生除与GPU交互之外的其他原因之外的未定义行为时。请参阅以下文档以获取更多详细信息

• 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中用于着色器管道。

运行演示

演示应在仓库的演示目录中运行。以下命令应克隆仓库并运行演示。

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多个投光灯
• HDR管道与泛光/自动曝光/TAA/SSAO/FidelityFX CAS
• HDR显示支持（仅在macOS上测试过，可能支持vulkan）
• 点、聚光灯和方向光
• 多个聚光灯/方向光/点光软阴影
• 字体渲染
• LDTK贴图导入
• 二维或三维中多个摄像头的截锥体剔除，支持正交或透视投影

工具

渲染器包含了一些处理着色器和打包二进制数据块的工具。

还有一个正在测试的Blender插件，但尚未文档化。

着色器处理器

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

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

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

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

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

打包资产

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

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

Blender 插件

还有一个Blender插件实现了大型级别的流程，并导出了一种自定义格式，避免了共享资产数据的重复。虽然它已经工作，但实现还处于早期阶段，尚未文档化。

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

^ Blender中基于切片的级别编辑视频

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

特性

• rafx-vulkan：使用vulkan后端
• rafx-metal：使用metal后端
• framework：包含并重新导出rafx-framework从rafx crate
• assets：包含并重新导出rafx-assets从rafx crate
• renderer：包含并重新导出rafx-renderer从rafx crate

crates

• 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许可证版本2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT 或 https://open-source.org.cn/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"。这在使用 cargo-deny 的每次 CI 运行中尽力进行验证。

致谢

Rafx 受益于许多 出色的想法和项目！

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义的任何有意提交以包含在作品中的贡献，将根据上述条款双重许可，不附加任何额外条款或条件。

请参阅 LICENSE-APACHE 和 LICENSE-MIT。