Lib.rs

› 模拟器 | 编程语言 › librashader
#retro-arch #shader #graphics-api #spir-v #graphics #vulkan-graphics

nightly librashader-runtime-vk

适用于所有 RetroArch 着色器

由 Ronny Chan 和 4 位贡献者 开发

58 个版本

新增 0.3.3 2024 年 8 月 22 日
0.2.8 2024 年 7 月 29 日
0.2.7 2024 年 3 月 8 日
0.2.0-beta.22023 年 11 月 30 日
0.1.3 2023 年 2 月 22 日

#385 在 模拟器

Download history 7/week @ 2024-05-17 3/week @ 2024-05-24 5/week @ 2024-05-31 6/week @ 2024-06-07 6/week @ 2024-06-14 1/week @ 2024-06-21 130/week @ 2024-07-26 152/week @ 2024-08-02 11/week @ 2024-08-09 302/week @ 2024-08-16

每月 595 次下载
在 2 个crate中使用（通过 librashader）

MPL-2.0 OR GPL-3.0-only

650KB
11K SLoC

librashader

Mega Bezel SMOOTH-ADV

DirectX 11上的Mega Bezel SMOOTH-ADV

librashader（/ˈli:brəʃeɪdɚ/）是一个为 RetroArch 'slang' 着色器编写的预处理程序、编译器和运行时，完全用 Rust 重写。

Latest Version Docs build result License Nightly rust

安装

对于最终用户，librashader 可以从各种 Linux 发行版和平台的 Open Build Service 获取。Windows 和 macOS 用户可以从 GitHub Releases 获取最新二进制文件。

支持的渲染 API

librashader 支持所有现代图形运行时，包括 wgpu、Vulkan、OpenGL 3.3+ 和 4.6（带有 DSA）、Direct3D 11、Direct3D 12 和 Metal。

librashader 不支持旧版渲染 API，如较旧的 OpenGL 或 Direct3D 版本，除了对 Direct3D 9 的实验性支持。

API 状态 librashader 功能
OpenGL 3.3+ ✅ gl
OpenGL 4.6 ✅ gl
Vulkan ✅ vk
Direct3D 9 🆗️ d3d9
Direct3D 11 ✅ d3d11
Direct3D 12 ✅ d3d12
Metal ✅ metal
wgpu 🆗 wgpu

✅ 全支持 — 🆗 二级支持

在二级支持的渲染 API 上，着色器的兼容性不能保证。

wgpu 对不能转换为 WGSL 的着色器有限制，例如使用 inverse 的着色器。Direct3D 9 不支持需要 Direct3D 10+ 只有的功能或不能编译为 Shader Model 3.0 的着色器。

使用方法

librashader 提供了在 librashader crate 下的 Rust API 和 C API。这两个 API 都是第一类的并且完全受支持。C API 更多的是针对与现有项目的集成。如果你希望部分使用 librashader，Rust librashader crate 暴露了更多的内部功能。

librashader C API的最佳使用方式是在项目中包含librashader_ld.h，它实现了一个动态加载器，可以在搜索路径中动态加载librashader的实现（librashader.so、librashader.dll或librashader.dylib）。

C兼容性

推荐通过包含librashader_ld单个头文件库来集成librashader，它实现了对librashader.dll / librashader.so / librashader.dylib的动态加载。有关librashader如何处理C ABI和API稳定性以及库更新的详细信息，请参阅版本策略。您也可以仅使用librashader.h及其等效的-lrashader进行动态链接。

对librashader.h进行静态链接是可能的，但官方不支持。您需要确保链接参数正确，以便成功链接到librashader.lib或librashader.a。强烈推荐使用corrosion CMake包。

线程安全

除了Metal运行时之外，通常，在另一个线程中创建过滤器链实例是安全的，但绘制帧需要外部同步过滤器链对象。

过滤器链可以在任何线程中创建，但对于适用的图形设备队列需要外部同步（在Direct3D 11中，立即上下文被认为是图形设备队列），因为加载LUT需要向GPU提交命令。可以使用filter_chain_create_deferred函数异步延迟初始化GPU资源，但调用者负责将记录的命令提交到图形设备队列，并在绘制着色器传递帧之前确保工作完成。

OpenGL有一个额外的限制，即如果和绘制线程相同的线程本地OpenGL上下文已初始化，则在不同的线程中创建过滤器链实例是安全的。OpenGL不支持GPU资源初始化的延迟。

Metal运行时不支持线程安全。但是，您仍然可以通过filter_chain_create_deferred函数延迟提交GPU资源初始化。

Direct3D 9 API不是线程安全的，除非在创建设备时启用了D3DCREATE_MULTITHREADED。

四边形顶点和旋转

所有运行时都使用单位矩阵MVP和范围在[-1, 1]的VBO来渲染中间传递。默认情况下，最后传递使用范围在[0, 1]的Quad VBO和以下投影矩阵。

static DEFAULT_MVP: &[f32; 16] = &[
  2.0, 0.0, 0.0, 0.0,
  0.0, 2.0, 0.0, 0.0,
  0.0, 0.0, 0.0, 0.0,
  -1.0, -1.0, 0.0, 1.0,
];

与RetroArch一样，对于这些运行时，将只在这个MVP上应用旋转。这是向着色器传递方向信息的唯一方法。

构建

对于Rust项目，只需将crate添加到您的Cargo.toml中。

cargo add librashader

要构建兼容C的动态库，运行构建脚本。

cargo run -p librashader-build-script -- --profile optimized

这将输出目标文件夹中的librashader.dll或librashader.so。配置可以是debug、release或optimized以进行完整的LTO。

虽然librashader没有编译时依赖，但使用librashader_ld.h可能需要相关运行时图形API的头文件。

编写librashader运行时

如果您希望贡献一个尚不可用的运行时实现，请参阅librashader-runtime crate，其中包含所有librashader运行时实现所使用的辅助工具和共享逻辑。使用这些辅助工具和特性将确保您的运行时与现有librashader运行时在均匀和纹理语义绑定方面具有一致的行为。

这些类型不应在运行时的公共API中公开，而应保留在运行时实现的内部。

示例

以下Rust示例展示了如何使用每个librashader运行时。

还提供了一些使用C API的基本示例。

兼容性

librashader实现了整个RetroArch着色器管道，并且与现有着色器高度兼容。

如果您遇到在RetroArch中可以工作但在librashader下不能工作的着色器，请报告问题。

  • 滤镜链不会终止在后缓冲区。
    • 与RetroArch不同，librashader并不完全了解整个渲染状态，并且被设计为可以在渲染管道的任何位置插入。相反，滤镜链将在调用者提供的输出表面和视口中终止。将表面绘制回后缓冲区是调用者的责任。
  • 尽可能并行编译着色器。这应该会明显减少预设的编译时间。OpenGL不支持并行着色器编译。
  • HDR10支持不是任何着色器运行时的一部分，并且librashader也不支持它。
  • 出于性能原因，不会为输入纹理生成mipmap。从理论上讲，这意味着具有mipmap_input0 = "true"的预设将不会获得mipmap输入。在实践中，没有已知的着色器预设设置mipmap_input0 = "true"。
  • 预设解析器是一个比RetroArch中实现更为严格的实现。并非所有的着色器预设都可能是兼容的。如果您发现这种情况，请提交问题以便添加一个解决方案。
  • 着色器在传递给驱动程序之前在SPIR-V级别预先链接。移除了片段着色器中的未使用输入，并将相应的顶点着色器输入降级为全局变量。

运行时特定差异

  • OpenGL
    • 通过glBlitFramebuffer将正在运行的帧缓冲区内容复制到历史记录中，而不是将一个四边形绘制到中间的FBO中。
    • 使用采样对象而不是glTexParameter。
    • 采样输入和输出不会被重命名。这对于在RenderDoc中调试着色器很有用。
    • UBO和Push Constant Buffer的大小被填充到16字节边界。
    • OpenGL运行时与其他运行时使用相同的VBO，以及用于中间传递的恒等矩阵MVP。RetroArch的OpenGL驱动程序只使用最终的VBO。
  • OpenGL 4.6+
    • 应考虑OpenGL 3.3+部分的所有注意事项。
    • 应在OpenGL 4.5上工作，但这不能保证。OpenGL 4.6运行时可能最终会切换到使用ARB_spirv_extensions来加载着色器，这将不会标记为一个破坏性更改。
    • OpenGL 4.6 运行时使用直接状态访问以最小化对 OpenGL 状态的更改。对于过去5年内发布的 GPU，这可能会提高性能。
    • OpenGL运行时与其他运行时使用相同的VBO，以及用于中间传递的恒等矩阵MVP。RetroArch的OpenGL驱动程序只使用最终的VBO。
  • Vulkan
    • Vulkan 运行时可以使用 VK_KHR_dynamic_rendering 扩展。必须在创建设备时启用此扩展。启用动态渲染并在主机硬件支持下，可能会提高性能。
    • 运行时内部的分配是通过 gpu-allocator 而不是手动处理的。
  • Direct3D 11
    • 帧缓冲区复制是通过 ID3D11DeviceContext::CopySubresourceRegion 而不是 CPU 转换 + 复制完成的。
  • Direct3D 12
    • Direct3D 12 运行时使用 渲染通道。此功能自 Windows 10 版本 1809 以来可用，该版本于 2018 年末发布。
    • 为了与着色器实现最大兼容性，使用基于 spirv-to-dxil 的着色器编译管道，SPIRV-Cross HLSL 管道作为后备。这使着色器兼容性超越了 RetroArch Direct3D 12 驱动器提供的。当 spirv-to-dxil 改进时，可能会移除 HLSL 管道后备。
    • Direct3D 12 运行时需要从 DirectX 着色器编译器 中的 dxcompiler.dll，它可能已经作为 Direct3D12 的一部分安装。不需要 dxil.dll。
  • Metal
    • Metal 运行时与其他运行时使用相同的 VBO，以及用于中间通道的同一单位矩阵 MVP。RetroArch 的 Metal 驱动程序仅使用最终的 VBO。

大多数，如果不是所有的着色器预设都应该在 librashader 上运行良好。特定于运行时的差异不应影响输出，更多是提醒将 librashader 集成到您的项目中。

版本号

Latest Version C ABI C API

librashader 通常遵循与 Rust API 相关的 语义版本控制，其中次要版本号的增加表示在 0.x.y 期间的“破坏性更改”，并且在 1.x.y 之后的“非破坏性更改”。然而，导致版本号增加的“破坏性更改”在版本 0.1.0 之后不对应于 C API 的中断。

C API 使用两个单调递增的版本号分别进行版本控制，并导出到 librashader C 头文件。

LIBRASHADER_CURRENT_VERSION 的增加保证对相同的 LIBRASHADER_CURRENT_ABI 兼容。它在语义版本控制术语中相当于“次要”版本，除了它总是单调递增。对 C API 的向后兼容性添加将导致 LIBRASHADER_CURRENT_VERSION 增加。

在某个 LIBRASHADER_CURRENT_VERSION 之后引入的 API 可能或可能不 可用于早期版本。特别是，由过滤器或帧选项结构启用的新功能 需要 LIBRASHADER_CURRENT_VERSION 大于或等于引入该选项的版本，否则将传递默认值，该值可能或可能不启用该功能，这取决于该特定功能的向后兼容性。

对 LIBRASHADER_CURRENT_ABI 的任何更改都表示 C ABI 发生了 重大变化。出于安全考虑，librashader_ld.h 将会检查以确保 LIBRASHADER_CURRENT_ABI 与已加载的 librashader 二进制文件的版本相匹配。如果不匹配，librashader 将无法加载。LIBRASHADER_CURRENT_ABI 的值为 0 表示“空”实例，其中每个操作都是无操作（no-op），这种情况发生在找不到兼容的 librashader 实现时。

通过包管理器安装时，librashader.so 的 SONAME 被设置为 LIBRASHADER_CURRENT_ABI。

上述内容不适用于 0.1.0 之前的 librashader 版本，这些版本在 Rust 和 C API 中可以破坏 API 和 ABI 兼容性，而不需要增加 LIBRASHADER_CURRENT_VERSION 或 LIBRASHADER_CURRENT_ABI。

MSRV 政策

虽然 librashader 需要 nightly Rust，但以下 MSRV 政策强制执行不稳定库功能。

  • Windows 和 macOS：最新版 nightly
  • Linux：1.76

每周运行 CI 任务以确保 librashader 可以在 nightly 上继续构建。请注意，MSRV 仅用于简化 Linux 上的分发，并且可以随时更改。它通常跟踪 Ubuntu 最新版本中可用的最新 Rust 版本，但在补丁版本中可能没有警告就更改。

许可

librashader 的核心部分，如预处理器、预设解析器、反射库和运行时，均采用 Mozilla 公共许可证版本 2.0 许可。

librashader C API（即其头文件和定义），而不是 librashader-capi 中的实现，具有更宽松的许可，可能允许您在宽松许可或专有项目中使用 librashader。

为了便于在不兼容 MPL-2.0 的项目中使用 librashader，librashader_ld 实现了一个加载器，它将调用推迟到在加载路径中找到的任何 librashader.so、librashader.dll 或 librashader.dylib 库。一个项目可以链接到 librashader_ld 以使用 librashader 运行时，前提是 librashader.so、librashader.dll 或 librashader.dylib 在 MPLv2 的限制下分发。

请注意，这意味着如果您的项目无法遵守 MPL-2.0 的要求，您 不能 与您的项目一起分发 librashader.so、librashader.dll 或 librashader.dylib。最终用户必须自行获取 librashader 的实现。有关更多信息，请参阅 MPL 2.0 常见问题解答。

您可以选择在 GPLv3 的条款下而不是 MPL-2.0 条款下分发 librashader。

依赖项

~45MB
~832K SLoC