Lib.rs

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

nightly librashader

适用于所有 RetroArch 着色器

由 Ronny Chan 和 4 位贡献者

63 个版本

新版本 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.0-alpha.42022 年 12 月 5 日

#18 在 模拟器

Download history 8/week @ 2024-05-20 5/week @ 2024-06-03 2/week @ 2024-06-10 268/week @ 2024-07-29 18/week @ 2024-08-05 12/week @ 2024-08-12

每月 298 次下载
在 librashader-capi 中使用

MPL-2.0 OR GPL-3.0-only

745KB
13K 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 可从 Open Build Service 获取，适用于各种 Linux 发行版和平台。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包下的Rust API和C API。这两个API都是一等API，并且完全受支持。C API更适合与现有项目集成。如果你希望分块使用librashader的部分功能，Rust librashader包会暴露更多内部细节。

在项目中包含librashader_ld.h是使用librashader C API的最佳方式，该文件实现了一个动态加载器，可以在搜索路径中动态加载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]的四边形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运行时使用渲染传递。此功能自2018年底发布的Windows 10版本1809以来一直可用。
    • 为了与着色器实现最大兼容性，使用了基于spirv-to-dxil的着色器编译管道，SPIRV-Cross HLSL管道用作后备。这带来了超越RetroArch Direct3D 12驱动程序提供的着色器兼容性。HLSL管道后备可能在将来被移除，因为spirv-to-dxil得到改进。
    • Direct3D 12运行时需要来自DirectX Shader Compiler的dxcompiler.dll，这可能是作为Direct3D12的一部分安装的。不需要dxil.dll。
  • Metal
    • Metal运行时与其他运行时使用相同的VBO以及中间过程使用的单位矩阵MVP。RetroArch的Metal驱动程序仅使用最终的VBO。

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

版本号

Latest Version C ABI C API

librashader通常遵循语义版本控制，其中次要版本号的增加表示在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 表示“空”实例，其中每个操作都是无操作，如果找不到兼容的 librashader 实现，就会发生这种情况。

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

上述内容不适用于 0.1.0 之前版本的 librashader 发布，这些发布允许在不增加 LIBRASHADER_CURRENT_VERSION 或 LIBRASHADER_CURRENT_ABI 的情况下，在 Rust 和 C API 中破坏 API 和 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 库。非 MPL-2.0 兼容的项目可以链接到 librashader_ld 来使用 librashader 运行时，前提是 librashader.so、librashader.dll 或 librashader.dylib 在 MPLv2 的限制下分发。

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

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

依赖关系

~28–85MB
~1.5M SLoC