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必须在您的路径中可用。它在演示和上游crate中用于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秒）**

演示功能

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

工具

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

还有一个可以工作的blender插件，但仍在原型设计阶段，尚未文档化。

着色器处理器

该工具解析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中基于切片的级别编辑的视频

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

功能

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

crate

• 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 或 http://www.apache.org/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。