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 在未来将不会获得太多改进/支持。

请注意，这个包仍然处于 0.1.0 之前的预发布状态！

• 文档
• 对于 rustdoc：在包的根目录下运行 cargo doc --no-deps --open（docs.rs 不完整，因为它不支持构建功能）

路线图

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

此包将在项目发布 0.1.0 之后使用语义版本控制规则。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 和 shader 管道中使用的上游包都使用 CMake。

运行演示

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

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 网格。**强烈建议使用配置文件覆盖来优化上游包。在调试模式下，资产处理速度非常慢**（即 30 秒而不是 2 秒）

演示功能

• 渲染线程与主线程解耦 (图)
• 着色器构建管道 (图)
• 离线纹理压缩和 mipmap 生成（通过 basis-universal 格式）
• 异步资产加载
• 可以将资产流式传输到远程硬件（例如手机）
• 或者可以将资产烹饪成二进制 blob 以便分发
• 热重新加载资产（需要更多工作，某些资产类型不可靠）
• 渲染图可用于高效且灵活地定义渲染管道，包括渲染到纹理、多个相机和计算着色器。
• 自动生成的着色器绑定使得使用描述符集方便且错误率低。
• 支持多个通道的材质系统
• 支持多摄像头（例如，生成阴影图）
• 演示游戏状态存储在 ECS 中（注意：演示使用 legion，但渲染器是 ECS 无关的）
• PBR 网格
• 精灵
• 调试绘制
• imgui/egui
• 具有阴影图缓存簇的前向光照，支持 100+ 阴影投射光源
• 具有泛光/自动曝光/TAA/SSAO/FidelityFX CAS 的 HDR 管道
• 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：使用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 或 http://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。