#gfx-hal #graphics #rendering-engine #rendy #graphics-api

rendy-command

Rendy的队列和命令工具

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日

#5 in #rendy

Download history 546/week @ 2024-03-14 791/week @ 2024-03-21 800/week @ 2024-03-28 598/week @ 2024-04-04 732/week @ 2024-04-11 732/week @ 2024-04-18 767/week @ 2024-04-25 660/week @ 2024-05-02 667/week @ 2024-05-09 688/week @ 2024-05-16 712/week @ 2024-05-23 801/week @ 2024-05-30 581/week @ 2024-06-06 555/week @ 2024-06-13 616/week @ 2024-06-20 465/week @ 2024-06-27

2,302 每月下载量
36 个crate中使用 (6个直接使用)

MIT/Apache

150KB
3.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 的特质,通过它将自动生成创建、写入和绑定所需集成的代码。通过 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:

此crate围绕命令记录和提交。

依赖项

~4.5–6.5MB
~125K SLoC