resvg doesn’t include a 2D graphics library and uses external ones via FFI.
Their support is implemented separately, therefore we call them backends.
You can build them separately or together.
At the moment, there are only two backends: Qt and cairo.
The first one uses the Qt framework and the second one uses the
cairo library.
Since resvg is a Rust library, you should build it via cargo.
To enable a backend use the --features option:
# Build with a Qt backend
cargo build --release --features="qt-backend"
# or with a cairo backend
cargo build --release --features="cairo-backend"
# or with both
cargo build --release --features="qt-backend cairo-backend"-
The library requires the latest stable Rust.
-
Qt backend requires only
QtCoreandQtGuilibraries and the JPEG image format plugin (akaplugins/imageformats/qjpeg).
Technically, any Qt 5 version should work, but we only support Qt >= 5.6. -
cairo backend requires cairo itself and pango for text rendering (with the
pangocairoglue library, which is an optional part of thepango).
There is no specific minimal supported version at the moment.
Install stable-x86_64-pc-windows-msvc Rust target.
Install Qt built with MSVC via an official installer.
Build using cmd.exe:
set PATH=%userprofile%\.cargo\bin;%PATH%
set QT_DIR=C:\Qt\5.12.0\msvc2015_64
cargo.exe build --release --features "qt-backend"Instead of msvc2015_64 you can use any other Qt MSVC build. Even 32-bit one.
We are using Qt 5.12.0 just for example.
Install stable-i686-pc-windows-gnu Rust target.
Install Qt built with MinGW 32-bit via an
official installer.
64-bit version, available since Qt 5.12, will not work due to #47048.
Build using cmd.exe:
set PATH=C:\Qt\5.11.3\mingw53_32\bin;C:\Qt\Tools\mingw530_32\bin;%userprofile%\.cargo\bin;%PATH%
set QT_DIR=C:\Qt\5.11.3\mingw53_32
cargo.exe build --release --features "qt-backend"Instead of mingw53_32 you can use any other Qt mingw build.
We are using Qt 5.11.3 just for example.
Install stable-x86_64-pc-windows-gnu Rust target.
Install GTK+ dependencies using MSYS2 as explained here.
We do not need the whole GTK+, so we can install only pango (which will install
cairo too) and gdk-pixbuf2:
pacman -S mingw-w64-x86_64-pango mingw-w64-x86_64-gdk-pixbuf2
cargo.exe build --release --features "cairo-backend"You can use x86/i686 target in the same way.
Install Qt 5 using your distributive package manager and then build resvg:
cargo build --release --features "qt-backend"If you don’t want to use a system Qt, you can alter it with the PKG_CONFIG_PATH variable.
PKG_CONFIG_PATH='/path_to_qt/lib/pkgconfig' cargo build --release --features "qt-backend"Using homebrew:
brew install qt
QT_DIR=/usr/local/opt/qt cargo build --release --features "qt-backend"Or an official Qt installer:
QT_DIR=/Users/$USER/Qt/5.12.0/clang_64 cargo build --release --features "qt-backend"We are using Qt 5.12.0 just for example.
Using homebrew:
brew install cairo pango gdk-pixbuf
cargo build --release --features "cairo-backend"resvg consists of 4 parts:
-
the Rust library (src)
-
the C library/bindings (capi)
-
the CLI tool to render SVG (tools/rendersvg)
-
the CLI tool to simplify SVG (tools/usvg)
All of them are optional and each one, except usvg, can be built with a specific backend.
No need to build rendersvg for each backend separately since it has a CLI switch
to choose which one to use in runtime.
Not sure how the Rust library can be packaged, but the C libraries should probably be built
separately.
So the final package can look like this:
/bin/rendersvg (does not depend on *.so)
/bin/usvg (completely optional)
/include/resvg.h (from capi/include)
/include/ResvgQt.h (from capi/include)
/lib/libresvg-cairo.so
/lib/libresvg-qt.so