Skip to main content

Package Overview

libvips_ffi is organized as a monorepo with multiple packages, each serving a specific purpose.

Package Architecture

┌─────────────────────────────────────────────────────────────┐
│ Your Application │
└─────────────────────────────────────────────────────────────┘

┌─────────────────────┼─────────────────────┐
▼ ▼ ▼
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ libvips_ffi │ │libvips_ffi_ │ │libvips_ffi_ │
│ (Flutter) │ │ desktop │ │ system │
└───────────────┘ └───────────────┘ └───────────────┘
│ │ │
└─────────────────────┼─────────────────────┘

┌───────────────┐
│libvips_ffi_api│
└───────────────┘


┌───────────────┐
│libvips_ffi_ │
│ core │
└───────────────┘

Package Summary

PackageTypeDescription
libvips_ffiFlutter PluginMain package for Android/iOS with bundled libraries
libvips_ffi_apiDartHigh-level Pipeline API
libvips_ffi_coreDartLow-level FFI bindings
libvips_ffi_desktopFlutter PluginMeta-package for all desktop platforms
libvips_ffi_macosFlutter PluginmacOS with bundled libraries
libvips_ffi_windowsFlutter PluginWindows with bundled libraries
libvips_ffi_linuxFlutter PluginLinux with bundled libraries
libvips_ffi_loaderDartDynamic library loader
libvips_ffi_systemDartSystem library finder

Choosing the Right Package

Flutter Mobile (Android/iOS)

dependencies:
libvips_ffi: ^0.1.0

Flutter Desktop (All Platforms)

dependencies:
libvips_ffi_api: ^0.1.0
libvips_ffi_desktop: ^0.1.0

Flutter Desktop (Specific Platform)

dependencies:
libvips_ffi_api: ^0.1.0
libvips_ffi_macos: ^0.1.0+8.17.0 # macOS only

Pure Dart with System libvips

dependencies:
libvips_ffi_api: ^0.1.0
libvips_ffi_system: ^0.1.0

Pure Dart with Custom Library Path

dependencies:
libvips_ffi_api: ^0.1.0
libvips_ffi_loader: ^0.1.0

Version Scheme

Packages follow semantic versioning with libvips version suffix:

<package_version>+<libvips_version>

Example: 0.1.0+8.17.0 means:

  • Package version: 0.1.0
  • Bundled libvips version: 8.17.0

libvips Versions

Different platforms may bundle different libvips versions:

Platformlibvips Version
Android8.16.0
iOS8.16.0
macOS8.17.0
Windows8.17.3
Linux(uses system)

Next Steps