7 个版本 (4 个重大变更)

0.5.1 2019年11月7日
0.5.0 2019年11月3日
0.4.1 2019年10月14日
0.4.0 2019年8月23日
0.1.0 2019年2月9日

#136 in 渲染

Download history 562/week @ 2024-04-04 712/week @ 2024-04-11 706/week @ 2024-04-18 745/week @ 2024-04-25 635/week @ 2024-05-02 644/week @ 2024-05-09 663/week @ 2024-05-16 684/week @ 2024-05-23 774/week @ 2024-05-30 563/week @ 2024-06-06 538/week @ 2024-06-13 590/week @ 2024-06-20 465/week @ 2024-06-27 148/week @ 2024-07-04 604/week @ 2024-07-11 510/week @ 2024-07-18

1,814 每月下载量
29 个crate中使用 (通过 rendy)

MIT/Apache

340KB
7.5K SLoC

Build Status Crates.io docs page MIT/Apache Lines of Code

基于 gfx-hal 的渲染引擎,它模拟了 Vulkan API。

构建

此库需要目标平台的标准构建工具,但在Windows的情况下,spirv-compiler功能需要安装Ninja以进行编译。 https://ninja-build.org

功能

最重要的是 rendy 通过检查重要状态和不变量,提供了更安全的API。它使用标记类型静态地检查不变量,并使用存储值动态地检查。

能力

队列家族能力定义了家族支持的操作队列。 rendy 提供了简单的机制来防止记录不受支持的命令。可以通过将能力类型之一标记为 Family 类型来静态地存储队列的能力级别:TransferGraphicsComputeGeneral(《Graphics 和 《Compute》合并)。或者可以使用 Capability 类型而不是标记类型,这样可以动态地检查实际的能力级别。

命令缓冲区

rendy 提供了一个名为 CommandBuffer 的便捷包装器。与原始版本相比,这个包装器将有关其状态的关键信息直接编码到类型中。这意味着用户无法意外

  • 记录队列家族不支持的操作。
  • 在命令缓冲区不在记录状态下记录命令。
  • 在渲染通道外记录渲染通道命令。
  • 在提交之前忘记完成缓冲区的记录。
  • 重新提交一个仅用于一次使用的命令缓冲区。
  • 将主缓冲区的执行记录到辅助缓冲区。
  • 等等

内存管理器

rendy 的内存管理器被称为 HeapsHeaps 提供了根据使用和可见性需求进行子分配设备可见内存的便捷方法。它还处理特定使用类型的映射。 对于 gfx-hal 采用 VMA 是可能的。在这种情况下,rendy 将使用它

渲染图

rendy 的渲染图允许以简单的模块化风格编写渲染代码。请注意,这并不是由高级图形库提供场景图,其中图中的节点对应于世界中的复杂对象。相反,它是一个具有不同属性的渲染阶段图。这使得从简单部分组合复杂帧变得容易得多。用户定义节点,声明它读取和写入哪些缓冲区和图像,渲染图负责瞬态资源分配和执行同步。用户只负责节点内的同步。

DynNode 实现 - RenderPassNode 可以从收集到子阶段的 RenderGroup 中构建。 RenderPassNode 将为渲染阶段创建和跨子阶段同步执行所有工作。将有更多的 NodeDynNodeRenderGroup 实现来进一步简化使用并减少各种用例所需的样板代码。

圆环

这种马戏团和队列的混合简化了同步主机对资源的访问。 Cirque 从资源特定分配器(例如,CommandPool 对于 CommandBufferFactory 对于 Buffer)分配资源的副本,并提供对未使用的副本的访问。

CPU-GPU 数据流

Rendy 可帮助在设备和主机之间发送数据。 Factory 类型可以选择最合适的技术将数据上传到设备本地内存。

  • 如果设备本地内存恰好是 CPU 可见的,将使用内存映射。
  • 相对较小的数据将直接上传到缓冲区。
  • 对于更大的上传或任何图像上传,将使用阶段缓冲区。 Factory 将根据用户请求自动插入同步命令。

GPU-CPU 数据流 - 尚未实现

数据驱动管道 - 正在进行中

我们认为在许多常见情况下,在半自动模式下向 GPU 提供数据是可能的。rendy::graph::node::render::RenderGroup 实现将使用 spirv-reflect(或类似包)直接从着色器中读取布局信息,并使用它来自动填充描述符和设置索引/顶点缓冲区,基于已注册的数据编码器和提供的场景实例。当前的 正在进行中 实现将使用 specs::World 作为场景进行渲染。

声明式管道 - 计划中

管道和描述符集具有声明性,以声明方式定义它们要容易得多。rendy 提供了一个名为 DescriptorSet 的 trait,通过它将自动生成设置创建、编写和绑定所需的代码。派生 GraphicsPipeline trait 将生成图形管道创建和使用所需的代码。对于计算管道,存在类似的 ComputePipeline trait。

示例

#[derive(DescriptorSet)]
struct Example {
    /// This field will be associated with binding 1 of type `VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER`.
    /// Actual `Buffer` will be allocated and kept updated by `Set<Example>`.
    #[descriptor(UniformBlock)]
    transform: mat4,

    /// This field will be associated with binding 2 of type `VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE`.
    /// `ImageView` will be fetched from `Texture` which implements `Borrow<ImageView>`.
    #[descriptor(SampledImage)]
    texture: Texture,

    /// Raw `gfx-hal` objects can be used as well.
    /// But this field will make binding `Set<Example>` to a command buffer an unsafe operation
    /// since it is the user's job to ensure that this raw image view is valid during command buffer execution.
    #[descriptor(unsafe, SampledImage)]
    foo: RawImageView,
}

模块化

rendy 提供的大部分功能都可以独立使用,这有助于保持 API 的整洁和清晰。顶级容器 crate rendy 为每个子 crate 提供了功能,以便它们可以单独启用(启用子 crate 也会启用其依赖项)。

变更日志

谁在使用它?

如果您知道其他使用 rendy 的项目,请友好地提交一个 PR 或问题。

许可证

许可方式任选其一

由您选择。


lib.rs:

纹理创建和使用

依赖项

~5.5–8.5MB
~157K SLoC