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月20日
0.1.0 2019年2月9日

#12 in #rendy

Download history 525/week @ 2024-04-05 722/week @ 2024-04-12 705/week @ 2024-04-19 703/week @ 2024-04-26 678/week @ 2024-05-03 639/week @ 2024-05-10 666/week @ 2024-05-17 660/week @ 2024-05-24 832/week @ 2024-05-31 437/week @ 2024-06-07 603/week @ 2024-06-14 627/week @ 2024-06-21 375/week @ 2024-06-28 199/week @ 2024-07-05 681/week @ 2024-07-12 488/week @ 2024-07-19

1,848 每月下载量
2 crate 中使用

MIT/Apache

390KB
9K 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 类型来静态地存储队列的能力级别: TransferGraphicsComputeGeneralGraphicsCompute 结合)。或者可以使用 Capability 类型代替标记类型,这样可以在动态中检查实际的能力级别。

命令缓冲区

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

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

内存管理器

rendy的内存管理器称为HeapsHeaps提供了方便的方法来基于使用和可见性要求子分配设备可见内存。它还处理特定使用类型的映射。**对于gfx-hal采用VMA的情况,rendy将使用它**

渲染图

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

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

环形队列

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

CPU-GPU数据流

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

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

GPU-CPU数据流 - 尚未实现

数据驱动管线 - 进行中

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

声明性管线 - 计划中

管线和描述符集具有声明性,以声明性定义它们要容易得多。rendy为此提供了一个名为DescriptorSet的特质。从中派生将自动生成所需集合创建、写入和绑定的代码。从GraphicsPipeline特质派生将生成图形管线创建和使用的代码。存在类似的ComputePipeline特质用于计算管线。

示例

#[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 的简洁和可维护性。顶层框架包 rendy 为每个子框架提供了功能,以便它们可以单独启用(启用子框架也将启用其依赖项)。

变更日志

谁在使用它?

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

许可证

许可协议为以下之一

任选其一。


lib.rs:

所有与帧相关的内容。

依赖项

~5–7MB
~137K SLoC