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日

#9#rendy

Download history 526/week @ 2024-03-13 825/week @ 2024-03-20 774/week @ 2024-03-27 719/week @ 2024-04-03 627/week @ 2024-04-10 751/week @ 2024-04-17 762/week @ 2024-04-24 672/week @ 2024-05-01 675/week @ 2024-05-08 670/week @ 2024-05-15 728/week @ 2024-05-22 842/week @ 2024-05-29 627/week @ 2024-06-05 513/week @ 2024-06-12 617/week @ 2024-06-19 561/week @ 2024-06-26

2,435 每月下载量
用于 37 个crate(7个直接使用)

MIT/Apache

205KB
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类型标记为以下能力类型之一来静态地存储队列的能力级别: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的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:

此crate提供创建/销毁以及管理设备资源的方法。主要关注缓冲区和图像。

依赖项

~2.7–3.5MB
~64K SLoC