Skip to content

Latest commit

 

History

History
119 lines (71 loc) · 5.66 KB

README.md

File metadata and controls

119 lines (71 loc) · 5.66 KB
Raw

Safe Rust bindings to the Skia Graphics Library.

Build Status

Skia Submodule Status: chrome/m73 (pending changes).

Goals

This project attempts to provide up to date safe bindings that bridge idiomatic Rust with Skia's C++ API on all major desktop, mobile, and WebAssembly platforms, including GPU rendering support for Vulkan, Metal, and OpenGL.

Building

Note that the information in this section is preliminary. Please open an issue for any build problem.

This project requires LLVM, python, and git to build.

To test if LLVM is installed with the correct version, use clang --version. Currently, version 7.0.1 is required, or - on macOS X - Apple LLVM Version 10 should do, too.

For python, at least version 2.7 should be available. Use python --version to see what's there.

macOS X

  • Install the XCode command line tools with xcode-select --install.
  • macOS X 10.14 (Mojave): install the SDK headers: /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg, otherwise the binding generation will fail with 'TargetConditionals.h' file not found.
  • Alternatively, install LLVM 7.0.1 via brew install llvm@7 and then set PATH, CPPFLAGS, and LDFLAGS like instructed.

Windows

  • Be sure the git command line tool is installed.
  • Install the official LLVM 7.0.1 distribution.
  • msys:
    • Install one of the Python2 packages, for example mingw-w64-x86_64-python2.
    • LLVM is always picked up from C:/Program Files/LLVM, so be sure it's available from there.
  • without msys:
    • Download and install Python version 2 from python.org.

Linux

  • LLVM should be installed out of the box, if not, install version 7.0.1.

Then use:

cargo build -vv

Under Linux, OpenGL libraries may be missing, if that is the case, install OpenGL drivers for you graphics card, or install a mesa OpenGL package like libgl1-mesa-dev.

Please share your build experience so that we can try to automate the build and get to the point where cargo build is sufficient to build the bindings including Skia, and if that is not possible, clearly prompts to what's missing.

To simplify and speed up the build, we also plan to provide prebuilt binaries for some of the major platforms (#49).

Feature vulkan

Vulkan support can be enabled by setting the Cargo feature default = ["vulkan"] in skia-safe/Cargo.toml, which will cause a rebuild of Skia. To render the examples with Vulkan use cargo run --example skia-org -- [OUTPUT_DIR] --driver vulkan.

Note that Vulkan drivers need to be available. On Windows, they are most likely available already, on Linux this article on linuxconfig.org might get you started, and on macOS with Metal support, install the Vulkan SDK for Mac and configure MoltenVK by setting the DYLD_LIBRARY_PATH, VK_LAYER_PATH, and VK_ICD_FILENAMES environment variables as described in Documentation/getting_started_macos.html.

Examples

The examples are taken from Skia's website and ported to the Rust API.

If you were able to build the project, run

cargo run --example skia-org -- [OUTPUT_DIR]

to generate some Skia drawn PNG images in the directory OUTPUT_DIR. To render with OpenGL, use

cargo run --example skia-org -- [OUTPUT_DIR] --driver opengl

And cargo run --example skia-org -- --help shows the drivers that are currently supported.

Status

Crate

An official crate is not yet available. We've created a Milestone on Github's issue tracker to track the progress.

Platforms

  • Windows
  • Linux Ubuntu 16 (18 should work, too).
  • macOS X
  • WebAssembly: #42 (help wanted).
  • Android
  • iOS

Bindings

Skia is a large library. While we strive to bind all of the C++ APIs, it's nowhere complete yet.

We do support most of the SkCanvas, SkPaint, and SkPath and related APIs and are trying to make the examples from the skia.org website work.

Features

  • Vector Graphics: Matrix, Rect, Point, Size, etc.
  • Basic Drawing: Surface, Canvas, Paint, Path.
  • Basic Effects and Shaders.
  • PDF
  • SVG
  • Animation
  • Vulkan
  • OpenGL
  • Metal

This project needs contributions!

If you'd like to help with the bindings, take a look at the Wiki to get started and create an issue to avoid duplicate work. For smaller tasks, grep for "TODO" in the source code. And for heroic work, check out the label help wanted. And if you like to help making the Rust API nicer to use, look out for open issues with the label api ergonomics.

Maintainers

  • LongYinan (@Brooooooklyn)
  • Armin (@pragmatrix)

License

MIT