2个版本
0.5.1 | 2019年11月7日 |
---|---|
0.5.0 | 2019年11月3日 |
#14 在 #rendy
74 每月下载量
在 2 个crate中(通过 rendy)使用
290KB
6.5K SLoC
基于 gfx-hal
的渲染引擎,该引擎模拟了 Vulkan
API。
构建
此库需要目标平台的标准构建工具,但在Windows的情况下, spirv-compiler 功能需要安装Ninja进行编译。 https://ninja-build.org
功能
最重要的是,rendy
通过检查重要状态和不变量提供了更安全的API。它使用标记类型静态地检查不变量,并使用存储值动态地检查。
能力
队列家族能力定义了家族支持的队列操作。 rendy
提供了简单的机制来防止记录不受支持的命令。可以通过将 Family
类型标记为以下能力类型之一来静态地存储队列的能力级别:Transfer
、Graphics
、Compute
或 General
(Graphics
和 Compute
的组合)。或者,可以使用 Capability
类型代替标记类型,这样就可以动态地检查实际的能力级别。
命令缓冲区
rendy
提供了一个名为 CommandBuffer
的便利包装器。与原始版本相比,此包装器直接将其状态的关键信息编码到类型中。这意味着用户不能意外地
- 在属于队列家族时不支持的命令。
- 当命令缓冲区不在记录状态时记录命令。
- 在renderpass外记录render pass命令。
- 在提交之前忘记完成记录缓冲区。
- 重新提交仅用于一次使用的命令缓冲区。
- 将主缓冲区的执行记录到辅助缓冲区。
- 等等
内存管理器
rendy
的内存管理器被称为 Heaps
。 Heaps
提供了根据使用和可见性要求进行子分配设备可见内存的便捷方法。它还处理特定用途类型的映射。 对于 gfx-hal
采用 VMA 是可能的。在这种情况下,rendy
将使用它
渲染图
rendy
的渲染图允许以简单的模块化风格编写渲染代码。请注意,这并不是高级图形库提供的场景图,其中图中的节点对应于世界中的复杂对象。相反,它是一个具有不同属性的渲染通道图。这使得从简单部分组合复杂帧变得更加容易。用户定义节点,声明它读取和写入哪些缓冲区和图像,渲染图负责暂存资源分配和执行同步。用户只需负责节点内部的同步。
DynNode
实现 - 从收集到子通道的 RenderGroup
中可以构建 RenderPassNode
。 RenderPassNode
将执行渲染通道创建和子通道同步的全部工作。还将有更多的 Node
、DynNode
和 RenderGroup
实现,以进一步简化使用并减少各种用例所需的样板代码。
马戏团
这种马戏团和队列的混合简化了同步主机对资源的访问。 Cirque
从资源特定分配器(例如,用于 CommandBuffer
的 CommandPool
,用于 Buffer
的 Factory
)分配资源的副本,并提供对未使用副本的访问。
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 或问题。
许可证
在以下许可证下授权
- Apache License, Version 2.0, (license/APACHE 或 https://apache.ac.cn/licenses/LICENSE2.0)
- MIT 许可证 (license/MIT 或 http://opensource.org/licenses/MIT)
任选其一。
lib.rs
:
简单的 rendy 初始化。它包含了在各个平台/后端上初始化 rendy 所需的大部分样板代码。如果该模块不支持您的案例,您仍然可以手动构建一切。
依赖项
~5–19MB
~271K SLoC