Lib.rs

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

librashader-common

适用于所有 RetroArch 着色器

由 Ronny Chan 和 4 位贡献者

72 个版本

0.40.0-beta.12024 年 8 月 11 日
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 日

#331 在 模拟器

Download history 42/week @ 2024-05-04 30/week @ 2024-05-11 57/week @ 2024-05-18 41/week @ 2024-05-25 47/week @ 2024-06-01 29/week @ 2024-06-08 43/week @ 2024-06-15 44/week @ 2024-06-22 10/week @ 2024-06-29 16/week @ 2024-07-06 59/week @ 2024-07-13 36/week @ 2024-07-20 199/week @ 2024-07-27 238/week @ 2024-08-03 161/week @ 2024-08-10 397/week @ 2024-08-17

每月 996 次下载
用于 14 个 crate (12 直接)

MPL-2.0 OR GPL-3.0-only

58KB
782 行

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

✅ 完全支持 — 🆗 二级支持 — ⚠️ 实验性支持

由于 WGSL 的限制，wgpu 可能不支持所有着色器。Direct3D 9 的支持是实验性的，并且不完全支持诸如前一帧反馈或历史记录等功能，同时无法支持需要 Direct3D 10+ 仅特性的着色器。

用法

librashader 提供了 Rust API 和 C API，均是一等公民，并得到完全支持。C API 更适合与现有项目集成。如果您想分部分使用 librashader，Rust librashader crate 暴露了更多内部功能。

librashader C API的最佳使用方法是，将librashader_ld.h包含到您的项目中，该文件实现了一个加载器，用于动态加载librashader（librashader.so、librashader.dll或librashader.dylib）实现并在搜索路径中。

C兼容性

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

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

线程安全

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

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

OpenGL有一个额外的限制，即如果并且只有在创建过滤器链实例的线程将本地OpenGL上下文初始化为与绘图线程相同的上下文时，从不同的线程创建过滤器链实例才是安全的。OpenGL不支持GPU资源初始化的延迟。

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

四边形顶点和旋转

所有运行时都使用单位矩阵MVP和VBO（范围[-1, 1]）渲染中间传递。默认情况下，最终传递使用具有范围[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着色器管道，并且与现有着色器高度兼容。

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

  • 滤波链不会在后缓冲区终止。
    • 与RetroArch不同，librashader并不完全了解整个渲染状态，并且设计成可以在渲染管道的任何位置进行插件。相反，滤波链在调用者提供的输出表面和视口处终止。将表面复制回后缓冲区是调用者的责任。
  • 在可能的情况下，着色器将并行编译。这应该会明显减少预置的编译时间。OpenGL不支持并行着色器编译。
  • HDR10支持不是任何着色器运行时的一部分，并且librashader也不支持。
  • 出于性能原因，从不为输入纹理生成Mipmap。从理论上讲，这意味着具有mipmap_input0 = "true"的预置将不会获得Mipmap输入。在实践中，没有已知的着色器预置设置了mipmap_input0 = "true"。
  • 预置解析器是一个比RetroArch中的实现更为严格的实现。并非所有着色器预置都可能兼容。如果您发现这种情况，请提交一个问题，以便添加一个解决方案。

运行时特定差异

  • 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 Shader Compiler的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 时，表示 "null" 实例，其中每个操作都是无操作（no-op），这种情况发生在找不到兼容的 librashader 实现时。

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

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

MSRV 政策

虽然 librashader 需要夜间 Rust，但对于不稳定库功能，以下 MSRV 政策将被强制执行。

  • Windows 和 macOS：最新版夜间构建
  • Linux：1.76

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

许可证

librashader 的核心部分，如预处理器、预设解析器、反射库和运行时，均采用 Mozilla Public License version 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 而不是 MPL-2.0 的条款下分发 librashader。

依赖项

~2–41MB
~635K SLoC