Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unused jextract definitions #108

Merged
merged 1 commit into from
Oct 12, 2024
Merged

Remove unused jextract definitions #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ libvips versions, assuming there haven't been major changes.

> [!NOTE]
> This library **does not** include `libvips` in the download, you must add it to the system/container you're building
> for, then make sure it's available in `DYLD_LIBRARY_PATH` (on macOS), `LD_LIBRARY_PATH` (on Linux), or `PATH` (on
> Windows).
> for. See details in [native library loading](#native-library-loading).

All libvips operations are exposed via helper classes, like `VImage`. You must provide an [Arena][1] to operations like
`VImage.newFromFile`, which constrains the lifetime of objects generated during usage. You can get an appropriate arena
Expand Down Expand Up @@ -141,6 +140,25 @@ memory: high-water mark 128.35 MB
[main] INFO vipsffm.SampleRunner - all samples ran successfully 🎉
```

## Native library loading

This library requires the `libvips`, `glib`, and `gobject` native libraries to be present in your library path:
* On macOS: `DYLD_LIBRARY_PATH` (eg `DYLD_LIBRARY_PATH=/opt/homebrew/lib` if you used `brew install vips`)
* On Linux: `LD_LIBRARY_PATH`
* On Windows: `PATH`

The naming conventions of these libraries are not consistent across operating systems, so vips-ffm attempts to load each
in the following order:
* `vips`, `vips.{abiNumber}`, `libvips-{abiNumber}`
* `glib-2.0`, `glib-2.0.{abiNumber}`, `libglib-2.0-{abiNumber}`
* `gobject-2.0`, `gobject-2.0.{abiNumber}`, `libgobject-2.0-{abiNumber}`

Override properties are provided to set your own "ABI number", but note that vips-ffm might not support that version
yet (which could manifest as crashes/segfaults):
* `vipsffm.abinumber.vips.override`, default: `42`
* `vipsffm.abinumber.glib.override`, default: `0`
* `vipsffm.abinumber.gobject.override`, default: `0`

## Project goals

Ideas and suggestions are welcome, but please make sure they fit in to these goals, or you have a good argument about
Expand Down
Loading