Rafx

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

此包包含几个层

• 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 以及在着色器管道中使用的上游软件包。

运行演示

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

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 秒）

演示功能

• 渲染线程与主线程解耦 (图)
• 着色器构建管道 (图)
• 离线纹理压缩和米普映射生成（通过 basis-universal 格式）
• 异步资产加载
• 可以将资产流式传输到远程硬件（例如手机）
• 或者可以将资产烹饪成二进制 blob 以进行分发
• 热重新加载资产（需要更多工作，一些资产类型不可靠）
• 渲染图可用于高效和灵活地定义渲染管道，包括渲染到纹理、多个相机和计算着色器。
• 自动生成的着色器绑定使使用描述符集变得方便且错误率更低。
• 支持多个通道的材料系统
• 多相机支持（例如，用于生成阴影图）
• 演示游戏状态存储在 ECS 中（注意：演示使用 legion，但渲染器是 ECS-agnostic）
• 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后端
• 框架：包含并从rafx crate重新导出rafx-framework
• 资源：包含并从rafx crate重新导出rafx-assets
• 渲染器：包含并从rafx crate重新导出rafx-renderer

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 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。