8 breaking releases

✓ Uses Rust 2018 edition

0.9.0 Jan 18, 2020
0.8.0 Aug 17, 2019
0.7.0 Jun 19, 2019
0.6.1 Mar 16, 2019
0.1.0 Dec 18, 2017

#8 in Images

Download history 424/week @ 2020-02-09 338/week @ 2020-02-16 358/week @ 2020-02-23 240/week @ 2020-03-01 336/week @ 2020-03-08 636/week @ 2020-03-15 999/week @ 2020-03-22 801/week @ 2020-03-29 780/week @ 2020-04-05 1175/week @ 2020-04-12 677/week @ 2020-04-19 1133/week @ 2020-04-26 1674/week @ 2020-05-03 1632/week @ 2020-05-10 1276/week @ 2020-05-17 1720/week @ 2020-05-24

2,247 downloads per month
Used in 14 crates (7 directly)

MPL-2.0 license

1MB
20K SLoC

Rust 12K SLoC // 0.1% comments Ruby 7K SLoC // 0.1% comments Coq 833 SLoC // 0.0% comments Ruby HTML 578 SLoC PowerShell 38 SLoC Scheme 15 SLoC // 0.3% comments

resvg

Build Status Crates.io Documentation

resvg is an SVG rendering library.

Purpose

resvg can be used as:

to render SVG files based on a static SVG Full 1.1 subset to raster images or to a backend's canvas (e.g. to a QWidget via QPainter).

The core idea is to make a fast, small, portable, multiple-backend SVG library designed for edge-cases.

Another major difference from other SVG rendering libraries is that resvg does a lot of preprocessing before rendering. It converts an input SVG into a simplified one called Micro SVG and only then it begins rendering. So it's very easy to implement a new rendering backend. And you can also access Micro SVG as XML directly via usvg tool.

SVG support

resvg is aiming to support only the static SVG subset; e.g. no a, script, view or cursor elements, no events and no animations.

A list of unsupported features can be found here.

SVG Tiny 1.2 and SVG 2.0 are not supported and not planned.

Results of the static subset of the SVG test suite:

Chart1

Results of the resvg test suite:

Chart2

You can find a complete table of supported features here. It also includes alternative libraries.

Performance

Comparing performance between different SVG rendering libraries is like comparing apples and oranges. Everyone has a very different set of supported features, implementation languages, build flags, etc. You should do the benchmarks by yourself, on your images.

Because of that, we are only comparing the relative performance between resvg backends, so you can choose the one by yourself. Also, it helps with regression testing. But you should note, that results still may vary depending on OS, hardware, and backend's underlying library version.

Chart3

  • elementary icons are very simple, and we are basically testing primitives rendering.
  • All icons were rendered with 4x zoom.
  • Qt has a slow path stroking/filling algorithm, but a fast layer compositing. So on complex files it's pretty fast, as you can see below.

Chart4

  • Oxygen icons are absurdly complex. Many files are more than 200KiB and total size is 1.2GiB! Most of the files include complex features like clipping, masking, patterns, blur and multiple layers.
  • All images were converted from .svgz to .svg beforehand.

The tests above we run on a single thread on Gentoo Linux with AMD 3700X and inside tmpfs. You can find the script here.

Used libraries: cairo 1.16.0, Qt 5.13.2, raqote 0.6.1, Skia m76

For more specific details checkout benches/README.md

Project structure

All other dependencies aren't written by me for this project.

Directory structure

  • benches - basic benchmarks for rendering operations
  • bindings – minimal bindings to Qt and Skia used by resvg
  • capi – C interface for resvg
  • docs – basic documentation
  • examples – usage examples for resvg as a library
  • src – source code
  • svgfilters - SVG filters implementation
  • testing-tools – scripts used for testing
  • tools – useful tools
  • usvg – an SVG simplification library used by resvg

Safety

  • The library must not panic. Any panic should be considered a critical bug and should be reported. There are only a few methods that can produce a panic.
  • The core library structure (see above) does not use any unsafe, but since all backends are implemented via FFI, we are stuck with unsafe anyway. Also, usvg uses unsafe for fonts memory mapping.

License

resvg is licensed under the MPLv2.0.

Dependencies

~2–3MB
~59K SLoC