vips-sys

Low-level Rust FFI bindings for libvips. Designed to be stable, minimal, and a foundation for higher-level wrappers.

Docs: https://houseme.github.io/vips-sys/vips_sys/
Requirement: Rust 1.85+ (edition 2024); libvips >= 8.2 (bindings generated from 8.18.6)
Goals: fast builds, reliable linking, cross-platform reuse

Highlights

	Default	Feature `bindgen`
Bindings	Pregenerated `src/bindings/prebuilt.rs`	Live bindgen via clang
Needs libclang?	No	Yes
Typical `cargo build`	Seconds	Slower (first time)
Use when	Normal development / CI	Updating API surface / new libvips

Normal builds do not run bindgen. You only need a libvips library to link against.

Installation

macOS

brew install vips pkg-config
# Apple Silicon:
export PKG_CONFIG_PATH=/opt/homebrew/lib/pkgconfig

Debian / Ubuntu

sudo apt-get install -y libvips-dev pkg-config

Windows (MSVC)

vcpkg install vips:x64-windows
set VCPKG_ROOT=C:\path\to\vcpkg

Static: vcpkg install vips:x64-windows-static and set VCPKG_DEFAULT_TRIPLET=x64-windows-static.

Verify: pkg-config --cflags --libs vips (MSVC uses vcpkg instead).

Cargo

[dependencies]
vips-sys = { version = "0.2.0", features = ["helpers"] }

Features

Feature	Default	Description
(none)	✓	Pregenerated bindings + link probe
`helpers`		`init` / `shutdown` / `version` / `version_string` (cached)
`static`		Prefer static linking (`LIBVIPS_STATIC=1` overrides)
`dynamic`		Prefer dynamic linking
`bindgen`		Regenerate bindings with clang against local headers
`stub`		Link `stub/vips_stub.c` when no system libvips is found (tests only)

Tests without a system libvips

cargo test --features helpers,stub

If pkg-config/vcpkg/LIBVIPS_LIB_DIR cannot find a real library, stub builds a tiny C stand-in (vips_init / vips_version / …) so unit tests can link. When a real library is present it is always preferred — never ship production binaries built with stub.

Static linking

vips-sys = { version = "0.2.0", features = ["static"] }

LIBVIPS_STATIC=1 cargo build

Resolution order:

pkg-config --static / vcpkg static triplet if a static libvips is installed
Meson + ninja build of vendor/libvips into OUT_DIR (if tools are on PATH)
Clear error otherwise

Vendored libvips (submodule)

vendor/libvips tracks libvips at v8.18.6 (see rust-sys-crate):

git clone --recurse-submodules <this-repo>
# or:
git submodule update --init --recursive

Link / header resolution:

LIBVIPS_LIB_DIR / LIBVIPS_INCLUDE_DIR (optional LIBVIPS_STATIC=1)
System library via pkg-config (Unix) or vcpkg (MSVC)
Static vendor build when static is requested
Vendored headers for include paths (still need a library to link)

Refreshing pregenerated bindings

# Requires: libclang, glib headers, and vips headers (system or vendor submodule)
cargo build --features bindgen
# build.rs prints the OUT_DIR path — copy it over:
cp target/debug/build/vips-sys-*/out/binding.rs src/bindings/prebuilt.rs

wrapper.h is the single bindgen entry point and is kept in the repo. generate.sh was removed in favor of the bindgen feature.

Build-time exports:

LIBVIPS_VERSION — detected version string (from pkg-config when available)
cfg(vips_8_16) / cfg(vips_8_17) — when version is new enough

Example (`helpers`)

use vips_sys::helpers;

fn main() {
    helpers::init("vips-sys-example").expect("vips init failed");
    let (a, b, c) = helpers::version();
    println!("libvips {}.{}.{} ({})", a, b, c, helpers::version_string());
    helpers::shutdown();
}

Environment variables

Variable	Purpose
`PKG_CONFIG_PATH`	Find `vips.pc`
`LIBVIPS_LIB_DIR` / `LIBVIPS_INCLUDE_DIR`	Explicit library / headers
`LIBVIPS_STATIC`	`1` prefer static; `0`/`false`/`off` disable
`LIBVIPS_NO_VENDOR`	Ignore `vendor/libvips`
`LIBVIPS_NO_BINDGEN`	With feature `bindgen`, skip generation
`LIBVIPS_VERSION`	Override version string for cfg
`VCPKG_ROOT` / `VCPKG_DEFAULT_TRIPLET`	Windows vcpkg
`BINDGEN_EXTRA_CLANG_ARGS`	Extra clang flags (bindgen feature)
`LIBCLANG_PATH`	libclang location (bindgen feature)

Troubleshooting

link error, library not found — install libvips (libvips-dev / vcpkg install vips)
bindgen feature fails — install libclang, glib headers, and vips headers
static on macOS — prefer dynamic (Homebrew); use vendor + meson for true static
Windows headers — set VCPKG_ROOT so include paths resolve

License

This crate’s Rust source code (including build.rs and src/) is licensed under MIT.

libvips itself is LGPL-2.1 (and depends on other LGPL/GPL-compatible components such as GLib). That license is not MIT and does not relicense this crate.

What that means for you

Artifact	License
`vips-sys` sources / pregenerated FFI declarations	MIT
Linked `libvips` library (system, vcpkg, or built from `vendor/`)	LGPL-2.1
Your final binary that links libvips	Must comply with LGPL-2.1 for libvips

Practical notes:

Dynamic linking (default): keep libvips replaceable/relinkable and ship the LGPL notice + a way to obtain libvips sources, as required by LGPL-2.1.
Static linking (static feature or vendored meson build): LGPL obligations are stricter (e.g. allow relinking against a modified libvips). Evaluate before shipping.
The vendor/libvips git submodule is LGPL-2.1 source. It is excluded from the crates.io package (exclude = ["vendor/"]); if you redistribute that tree yourself, do so under LGPL-2.1.
Pregenerated bindings are FFI declarations of the public C API, not a copy of libvips implementation code.

This is engineering guidance, not legal advice. For commercial compliance, consult counsel.

Changelog

See CHANGELOG.md.

vips-sys 0.2.0