skulpin

Skia + Vulkan = Skulpin

此crate通过结合vulkan和skia，提供了一个简单的方式来绘制硬件加速的2D图形。

请注意在使用此crate之前查看crate的状态。

此crate主要依赖于

• rafx - 一个易于访问vulkan后端的渲染框架
• skia-safe - Rust的Skia绑定

注意：有关如何获取skia二进制文件的更多信息，请参阅skia-bindings。在许多情况下，此crate将下载由其项目的CI创建的二进制文件。

此crate与raw-window-handle集成，这使得它可以与sdl2、winit以及任何支持raw-window-handle的窗口框架一起使用。

运行示例

首先，请确保满足以下要求，具体取决于操作系统。之后，可以正常运行示例。

交互式示例是一个获取键盘/鼠标输入的好方法。

# winit 0.24
cargo run --example interactive_winit_app --features winit-app,winit-25

# sdl2
cargo run --example interactive_sdl2

物理演示也很有趣。

cargo run --example physics --features winit-app,winit-25

这是物理和交互式示例的视频。

状态

我不再使用此crate进行任何操作，因此将仅以非常基本的方式维护此crate。我将审查简单的pull请求，并在打开的问题上提出建议。然而，我可能会在任何时候完全关闭此存储库，尤其是如果crate停止工作并且需要更多非平凡更改来修复它。遗憾的是，我在开源方面的时间有限，因此我想将重点放在我认为对我个人最有兴趣的crate上。我愿意将crate的所有权转让给那些提交了一些PR并证明自己值得信赖的人，并且如果有人创建了一个分支，我会很乐意链接到它。

用法

目前有几种方式可以与 winit 库一起使用。

• 应用 - 实现 AppHandler 接口并启动应用。这很简单，但不是很灵活。目前仅支持使用 winit。
• 仅渲染器 - 你自己管理窗口和事件循环。然后添加渲染器来绘制。窗口应包裹在 skulpin::Window 的实现中。已提供 sdl2 和 winit 的实现。

如果你更喜欢 sdl2，则需要直接使用渲染器。请参阅 仅 SDL2 渲染器

不要忘记安装以下适用于您平台的先决条件！（请参阅“要求”）

功能标志

Skia 相关功能

• skia-complete - 包括以下所有 Skia 功能。** 默认开启 **
• skia-shaper - 启用使用 Harfbuzz 和 ICU 的文本形状
• skia-svg - 此功能启用 SVG 渲染后端
• skia-textlayout - 使 Skia 模块 skparagraph 可用，其中包含用于段落布局的类型
• 有关这些标志的更多信息，请参阅 skia-safe 读取文件

skia-bindings 预构建的二进制文件仅适用于某些功能的组合。截至本文写作时，它适用于无、每个功能单独或所有功能启用。需要 vulkan 功能，并且隐式使用，因此启用任何功能单独将显着增加构建时间。建议使用所有功能（默认行为），或禁用所有功能。（使用 default-features = false）

Skulpin 功能

• winit-app - 包含 winit 应用包装器。与直接使用渲染器相比，它不太灵活，但很容易使用。

如果你使用 winit-app，你必须指定 winit 版本功能标志（见下文）

Winit 版本功能标志

• winit-21
• winit-22
• winit-23
• winit-24
• winit-25
• winit-latest

（这些功能名称与 imgui-rs 包匹配。）

功能标志使用示例

# Pull in all skia features and support for all backends (sdl2 and winit)
skulpin = "0"

# Pull in all skia features but not the winit app wrapper
skulpin = { version = "0", default-features = false, features = ["skia-complete"] }

# Pull in all skia features and include the winit app wrapper
skulpin = { version = "0", default-features = false, features = ["skia-complete", "winit-app"] }

skia-safe 的上游版本控制

Skulpin 可以与许多版本的 skia-safe 构建和使用。为了适应库的用户，所需版本已被留空。这允许新项目使用这些库的较新版本，同时不会强制旧项目更新。

你可以通过使用 cargo update

cargo update -p skia-safe --precise 0.32

文档

由于 skia_safe 包需要互联网连接来构建，因此文档在 docs.rs 上无法构建。（它将获取 skia 源代码或获取预构建的二进制文件。）因此，查看文档的最佳方式是自己构建它们

cargodoc -pskulpin --open

要求

最低要求的 rust 版本： 1.43.0

Windows

• 如果你使用的是 GNU 工具链（MSVC 是默认值），你可能会在构建 curl 时遇到问题。（Curl 是 skia_safe 绑定的依赖项，用于下载预构建的 skia 二进制文件。）这里有一些 解决方案列表。再次强调，这只会影响你使用非默认 GNU 工具链的情况。
• 如果您正在使用SDL2，请参阅SDL2绑定的要求。最简单的方法是使用“捆绑”和“静态”功能。为此，将以下代码添加到您的Cargo.toml文件中：sdl2 = { version = ">=0.33", features = ["bundled", "static-link"] }。这些功能在示例中默认启用。
• 启用vulkan验证需要LunarG验证层和可在您的PATH中看到的Vulkan库。开始的一个简单方法是使用LunarG Vulkan SDK

MacOS

• 如果您正在使用SDL2，请参阅SDL2绑定的要求。最简单的方法是使用“捆绑”和“静态”功能。为此，将以下代码添加到您的Cargo.toml文件中：sdl2 = { version = ">=0.33", features = ["bundled", "static-link"] }。这些功能在示例中默认启用。
• 启用vulkan验证需要LunarG验证层和可在您的PATH中看到的Vulkan库。开始的一个简单方法是使用LunarG Vulkan SDK

Linux

• 如果您正在使用SDL2，请参阅SDL2绑定的要求。最简单的方法是使用“捆绑”和“静态”功能。为此，将以下代码添加到您的Cargo.toml文件中：sdl2 = { version = ">=0.33", features = ["bundled", "static-link"] }。这些功能在示例中默认启用。
• 在Linux上，您还需要链接到bz2、GL、fontconfig和freetype。
  • 在Ubuntu上，您可以使用libbz2-dev、libfreetype6-dev、libfontconfig1-dev和libgl-dev。（以及libvulkan-dev以获取Vulkan SDK）
• 启用vulkan验证需要LunarG验证层和可在您的PATH中看到的Vulkan库。开始的一个简单方法是使用LunarG Vulkan SDK

其他平台

可能可以为移动平台构建此程序，但我还没有调查这个问题。

关于高DPI显示支持的问题

对于常见情况，您可以使用“逻辑”坐标在skia画布上绘图，而不必担心dpi/缩放问题。

内部，skia表面将与swapchain大小匹配，但这个大小不一定是窗口的逻辑大小或物理大小。为了产生一致大小的结果，渲染器将在将其传递给您的绘图实现之前，对skia画布应用一个缩放因子。

重要的配置选择

在配置应用程序的运行方式时，您应该考虑以下几个主要选择

• 坐标系 - 此库可以配置为使用几种不同的坐标系。
  • Logical - 使用逻辑坐标，这些坐标是经过应用因子计算的像素
  • Physical - 使用原始像素作为坐标
  • VisibleRange - 尝试将给定范围适应到窗口
  • FixedWidth - 使用给定的X范围和纵横比来计算Y范围
  • None - 不要修改画布矩阵
• 演示模式 - 您可能会想要Fifo（默认）或Mailbox
  • Fifo (VK_PRESENT_MODE_FIFO_KHR)是默认行为，并且始终存在于完全符合规范设备上。这将VSync，不应该出现屏幕撕裂，并且通常会以显示刷新率运行。
  • Mailbox (VK_PRESENT_MODE_MAILBOX_KHR)会尽可能快地渲染。帧将被排队，并将绘制最新完成的帧。其他帧将被丢弃。此渲染方法将产生最低延迟，但并不总是可用，并且可能会对笔记本电脑和移动设备的电池寿命造成不必要的消耗。
  • 有关详细信息，请参阅prefer_fifo_present_mode/prefer_mailbox_present_mode的简单方法，或使用present_mode_priority进行完全控制。
  • 有关完整详细信息，请参阅PresentMode的文档和Vulkan规范。
• 设备类型 - 最常见的设备类型将是专用或集成。默认情况下，如果可用，将选择专用设备。
  • 离散 (VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU) - 如果可用，这可能是性能最佳的设备
  • 集成 (VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU) - 这通常比离散GPU更节能。
  • 我认为同时拥有这两种设备的最可能情况是一台带有离散GPU的笔记本电脑。我预计优先考虑集成GPU将更有利于电池寿命，但会牺牲一些性能。然而，我没有合适的设备来测试这一点。
  • 有关在两个推荐选项之间进行简单选择或对完整控制，请参阅 prefer_integrated_gpu/prefer_discrete_gpu 或 physical_device_type_priority
  • 有关完整详细信息，请参阅 PhysicalDeviceType 的文档和 Vulkan 规范。
• Vulkan 调试层 - 默认情况下未启用调试日志
  • use_vulkan_debug_layer 开启/关闭所有日志
  • validation_layer_debug_report_flags 允许选择特定的日志级别
  • 如果未安装 Vulkan SDK，则启用任何 Vulkan 调试时，应用程序将无法启动

许可证

根据您的选择，许可如下：

• Apache License, Version 2.0, (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

任选其一。

字体目录包含受各自许可证保护的多个字体

• Feather, MIT
• Material Design Icons, SIL OFL 1.1
• FontAwesome 4.7.0, 可在 SIL OFL 1.1 下使用
• mplus-1p-regular.ttf, 可在其自己的许可证下使用。

sdl2 使用 zlib 许可证。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义的任何有意提交以包含在您的工作中的贡献，将按上述方式双许可，不附加任何额外条款或条件。

请参阅 LICENSE-APACHE 和 LICENSE-MIT。