vips-ffm

https://vipsffm.photofox.app
Admin
vips-ffm is a fast, safe, and complete Foreign Function & Memory API bindings library for libvips...
Tokens:360,315
Snippets:3,208
Trust Score:5.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Gradle Setup for vips-ffm

Source: https://vipsffm.photofox.app/index.html

Add the vips-ffm core dependency to your Gradle project to start using the library. Ensure you have mavenCentral() configured in your repositories.

```gradle
repositories {
    mavenCentral()
}

dependencies {
    implementation("app.photofox.vips-ffm:vips-ffm-core:1.9.6")
}
```

--------------------------------

### vips_source_new_from_blob$handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Gets the method handle for vips_source_new_from_blob.

```APIDOC
## vips_source_new_from_blob$handle()

### Description
Provides a method handle for the `vips_source_new_from_blob` function. This handle can be used to invoke the function, often in contexts requiring method handles, such as through Java's MethodHandle API.

### Signature
`static MethodHandle vips_source_new_from_blob$handle()`
```

--------------------------------

### Create VipsSource from Options String

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a VipsSource from a string of options. The options string must be null-terminated.

```c
extern VipsSource *vips_source_new_from_options(const char *options)
```

--------------------------------

### Create VipsSource from File Path

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a VipsSource from a file path. The filename must be a null-terminated string.

```c
extern VipsSource *vips_source_new_from_file(const char *filename)
```

--------------------------------

### Get finalize Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the finalize function pointer from a given MemorySegment. This is a getter for the finalize field.

```java
public static MemorySegment finalize(MemorySegment struct)
```

--------------------------------

### init

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Initializes the VIPS library with a given Arena.

```APIDOC
## init

### Description
Initializes the VIPS library with a given Arena.

### Method
public static void init(Arena arena)

### Parameters
#### Path Parameters
- **arena** (Arena) - The Arena to use for initialization.
```

--------------------------------

### Get dispose Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the dispose function pointer from a given MemorySegment. This is a getter for the dispose field.

```java
public static MemorySegment dispose(MemorySegment struct)
```

--------------------------------

### vips_source_new_from_descriptor$handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Gets the method handle for vips_source_new_from_descriptor.

```APIDOC
## vips_source_new_from_descriptor$handle()

### Description
Provides a method handle for the `vips_source_new_from_descriptor` function. This handle can be used to invoke the function, often in contexts requiring method handles, such as through Java's MethodHandle API.

### Signature
`static MethodHandle vips_source_new_from_descriptor$handle()`
```

--------------------------------

### Run All Samples

Source: https://vipsffm.photofox.app/index.html

This log output shows the execution of various samples, including version checks, thumbnail generation, and image manipulation operations. It confirms successful validation for each sample run.

```log
[main] INFO vipsffm.SampleRunner - clearing sample run directory at path "sample_run"
[main] INFO vipsffm.SampleRunner - running sample "RawGetVersionSample"...
[main] INFO vipsffm.sample.RawGetVersionSample - libvips version: "8.15.5"
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "HelperGetVersionSample"...
[main] INFO vipsffm.sample.HelperGetVersionSample - libvips version: "8.15.5"
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageCreateThumbnailSample"...
[main] INFO vipsffm.sample.VImageCreateThumbnailSample - source image size: 2490 x 3084
[main] INFO vipsffm.sample.VImageCreateThumbnailSample - thumbnail image size: 323 x 400
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageChainSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VSourceTargetSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageCopyWriteSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VOptionHyphenSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageCachingSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageBlobSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageArrayJoinSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VBlobByteBufferSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VTargetToFileSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageJoinSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageFromBytesSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - running sample "VImageStreamSample"...
[main] INFO vipsffm.SampleRunner - validation succeeded ✅
[main] INFO vipsffm.SampleRunner - shutting down vips to check for memory leaks...
memory: high-water mark 151.24 MB
[main] INFO vipsffm.SampleRunner - all samples ran successfully 🎉

```

--------------------------------

### Get get_property Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the get_property function pointer from a given MemorySegment. This is a getter for the get_property field.

```java
public static MemorySegment get_property(MemorySegment struct)
```

--------------------------------

### Create VipsSource from File Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsSource from an existing file descriptor. Ensure the descriptor is valid.

```c
extern VipsSource *vips_source_new_from_descriptor(int descriptor)
```

```java
public static MemorySegment vips_source_new_from_descriptor(int descriptor)
```

--------------------------------

### Get set_property Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the set_property function pointer from a given MemorySegment. This is a getter for the set_property field.

```java
public static MemorySegment set_property(MemorySegment struct)
```

--------------------------------

### Generate Thumbnail with vips-ffm (Kotlin)

Source: https://vipsffm.photofox.app/index.html

This Kotlin example demonstrates loading an image, creating a thumbnail, and saving it to disk using vips-ffm. It utilizes `Vips.run` for arena management and `VImage.thumbnail` for the operation. Remember to include `--enable-native-access=ALL-UNNAMED` in your JVM arguments.

```kotlin
import app.photofox.vipsffm.Vips
import app.photofox.vipsffm.VImage
import app.photofox.vipsffm.VipsOption
import app.photofox.vipsffm.enums.VipsAccess

// ...

// Use `Vips.run` to wrap your usage of the API, and get an arena with an appropriate lifetime to use
// Usage of the API, arena, and resulting V-Objects must be done from the thread that called `Vips.run`
Vips.run { arena ->
    val thumbnail = VImage.thumbnail(
      arena,
      "sample/src/main/resources/sample_images/rabbit.jpg",
      400,
      VipsOption.Boolean("auto-rotate", true) // example of an option
    )
    val thumbnailWidth = thumbnail.width
    val thumbnailHeight = thumbnail.height
    logger.info("thumbnail image size: $thumbnailWidth x $thumbnailHeight")

    val outputPath = workingDirectory.resolve("rabbit_thumbnail.jpg")
    thumbnail.writeToFile(outputPath.absolutePathString())
}

// Optionally call at the end of your program, for memory leak detection, from any thread
Vips.shutdown()
```

--------------------------------

### Get constructor Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the constructor function pointer from a given MemorySegment. This is a getter for the constructor field.

```java
public static MemorySegment constructor(MemorySegment struct)
```

--------------------------------

### Get Blob Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Retrieves the memory address for the vips_value_get_blob function. Use this to get the address of the C function.

```java
public static MemorySegment vips_value_get_blob$address()
```

```c
extern void *vips_value_get_blob(const GValue *value, size_t *length)
```

--------------------------------

### Get Image Filename Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_filename. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_filename$descriptor()
Function descriptor for: 
extern const char *vips_image_get_filename(const VipsImage *image)
```

--------------------------------

### VipsOption.Source Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.Source.html

Constructs a new VipsOption.Source instance with the provided key and an atomic reference to an optional VSource.

```APIDOC
## Source Constructor

### Description
Creates an instance of a `Source` record class.

### Parameters
* `key` (String) - the value for the `key` record component
* `box` (AtomicReference<Optional<VSource>>) - the value for the `box` record component
```

--------------------------------

### Method Summary - constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Methods for getting and setting the 'constructor' callback of _GObjectClass.

```APIDOC
static MemorySegment constructor(MemorySegment struct)
Getter for field: GObject *(*constructor)(GType, guint, GObjectConstructParam *)

static void constructor(MemorySegment struct, MemorySegment fieldValue)
Setter for field: GObject *(*constructor)(GType, guint, GObjectConstructParam *)

static final AddressLayout constructor$layout()
Layout for field: GObject *(*constructor)(GType, guint, GObjectConstructParam *)

static final long constructor$offset()
Offset for field: GObject *(*constructor)(GType, guint, GObjectConstructParam *)
```

--------------------------------

### Get Image Fields Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_fields. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_fields$descriptor()
Function descriptor for: 
extern gchar **vips_image_get_fields(VipsImage *image)
```

--------------------------------

### Initialize Vips Library

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Initializes the Vips library. Requires an Arena and the program name (argv0). Can throw VipsError.

```java
public static int init(Arena arena, String argv0String) throws VipsError
```

--------------------------------

### Get Image Data Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_data. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_data$descriptor()
Function descriptor for: 
extern const void *vips_image_get_data(VipsImage *image)
```

--------------------------------

### Get Image Concurrency Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_concurrency. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_concurrency$descriptor()
Function descriptor for: 
extern int vips_image_get_concurrency(VipsImage *image, int default_concurrency)
```

--------------------------------

### New Source From Options

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_source_new_from_options`. Creates a new VipsSource from a string of options.

```java
public static MemorySegment source_new_from_options(Arena arena, String optionsString) throws VipsError
```

--------------------------------

### New Source From File

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_source_new_from_file`. Creates a new VipsSource from a filename.

```java
public static MemorySegment source_new_from_file(Arena arena, String filenameString) throws VipsError
```

--------------------------------

### Get VipsImage Coding Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_coding. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_coding$descriptor()
Function descriptor for: 
extern VipsCoding vips_image_get_coding(const VipsImage *image)
```

--------------------------------

### Get construct_properties Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GObjectClass.html

Gets the construct_properties (GSList pointer) value from a given MemorySegment. This is a getter for the construct_properties field.

```java
public static MemorySegment construct_properties(MemorySegment struct)
```

--------------------------------

### Create VipsSource from Memory

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a VipsSource from a memory buffer. The data pointer and length must be valid.

```c
extern VipsSource *vips_source_new_from_memory(const void *data, size_t length)
```

--------------------------------

### newFromSource (with option string)

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Creates a new VImage from a VSource with an additional option string.

```APIDOC
## newFromSource (with option string)

### Description
Creates a new VImage from a VSource with an additional option string.

### Method
`public static VImage newFromSource(Arena arena, VSource source, String optionString, VipsOption... options)`

### Parameters
#### Path Parameters
- **arena** (Arena) - The arena that bounds resulting memory allocations during this operation
- **source** (VSource) - The VSource to load the image from
- **optionString** (String) - A string containing options for loading
- **options** (VipsOption...) - Array of VipsOption to apply to this operation

### Throws
- `VipsError`
```

--------------------------------

### Get Ref String Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Retrieves the memory address for the vips_value_get_ref_string function. Use this to get the address of the C function.

```java
public static MemorySegment vips_value_get_ref_string$address()
```

```c
extern const char *vips_value_get_ref_string(const GValue *value, size_t *length)
```

--------------------------------

### Get Save String Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Retrieves the memory address for the vips_value_get_save_string function. Use this to get the address of the C function.

```java
public static MemorySegment vips_value_get_save_string$address()
```

```c
extern const char *vips_value_get_save_string(const GValue *value)
```

--------------------------------

### VipsSource Creation and Handling

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Functions for creating and managing VipsSource objects from various sources like blobs, files, memory, and descriptors.

```APIDOC
## source_custom_new

### Description
Creates a new custom VipsSource.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.

### Response
- **MemorySegment** - A pointer to the newly created custom VipsSource.
```

```APIDOC
## source_get_type

### Description
Retrieves the GType of a VipsSource.

### Method
static long

### Response
- **long** - The GType of the VipsSource.
```

```APIDOC
## source_new_from_blob

### Description
Creates a new VipsSource from a VipsBlob.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **blob** (MemorySegment) - The VipsBlob to create the source from.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

```APIDOC
## source_new_from_descriptor

### Description
Creates a new VipsSource from a file descriptor.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **descriptor** (int) - The file descriptor.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

```APIDOC
## source_new_from_file

### Description
Creates a new VipsSource from a file path.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **filenameString** (String) - The path to the file.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

```APIDOC
## source_new_from_memory

### Description
Creates a new VipsSource from in-memory data.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **data** (MemorySegment) - A pointer to the memory data.
- **length** (long) - The length of the data.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

```APIDOC
## source_new_from_options

### Description
Creates a new VipsSource from a string of options.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **optionsString** (String) - The string containing options.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

```APIDOC
## source_new_from_target

### Description
Creates a new VipsSource from a VipsTarget.

### Method
static MemorySegment

### Parameters
- **arena** (Arena) - The arena to use for memory allocation.
- **target** (MemorySegment) - The VipsTarget to create the source from.

### Response
- **MemorySegment** - A pointer to the newly created VipsSource.
```

--------------------------------

### Vips Blob Get Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_blob_get function. Useful for direct memory access or interop.

```java
public static MemorySegment vips_blob_get$address()
```

--------------------------------

### VipsOption.String Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.String.html

Creates a new instance of the VipsOption.String record. This constructor is used to initialize a string option with a key and a boxed value.

```APIDOC
## VipsOption.String Constructor

### Description
Creates an instance of a `String` record class.

### Parameters
- **key** (String) - The value for the `key` record component.
- **box** (AtomicReference<Optional<String>>) - The value for the `box` record component.
```

--------------------------------

### init

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Initializes the Vips library. This function is a binding for the C function `vips_init`.

```APIDOC
## init

### Description
Initializes the Vips library. This function is a binding for the C function `vips_init`.

### Parameters
- `arena` (Arena) - The arena for memory management.
- `argv0String` (String) - The name of the program (argv[0]).

### Returns
- `int` - Returns 0 on success, or a negative error code on failure.
```

--------------------------------

### Get Vips Area Unref Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_area_unref function. This is useful for low-level memory operations.

```Java
public static MemorySegment vips_area_unref$address()
```

--------------------------------

### VipsLibLookup Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsLibLookup.html

Initializes a new instance of the VipsLibLookup class.

```APIDOC
## VipsLibLookup()

### Description
Constructs a new VipsLibLookup object.

### Constructor
`VipsLibLookup()`
```

--------------------------------

### Get Vips Object Description Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_object_get_description function. This is useful for low-level memory access.

```Java
public static MemorySegment vips_object_get_description$address()
```

--------------------------------

### Custom Source New

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_source_custom_new`. Creates a new VipsSourceCustom.

```java
public static MemorySegment source_custom_new(Arena arena) throws VipsError
```

--------------------------------

### GValue Get Object Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the function descriptor for getting a GObject from a GValue. Used for defining function signatures.

```java
public static FunctionDescriptor g_value_get_object$descriptor()
```

```c
extern gpointer g_value_get_object(const GValue *value)
```

--------------------------------

### newFromSource (without option string)

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Creates a new VImage from a VSource.

```APIDOC
## newFromSource (without option string)

### Description
Creates a new VImage from a VSource.

### Method
`public static VImage newFromSource(Arena arena, VSource source, VipsOption... options)`

### Parameters
#### Path Parameters
- **arena** (Arena) - The arena that bounds resulting memory allocations during this operation
- **source** (VSource) - The VSource to load the image from
- **options** (VipsOption...) - Array of VipsOption to apply to this operation

### Throws
- `VipsError`
```

--------------------------------

### Get VipsImage Integer Field Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Retrieves the memory address for vips_image_get_int, used to get an integer field from a VipsImage.

```java
extern int vips_image_get_int(const VipsImage *image, const char *name, int *out)
```

--------------------------------

### Initialization

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/Vips.html

Initializes the Vips library. Automatic initialization occurs when vips-ffm classes are used, so manual calls are usually not required.

```APIDOC
## init

### Description
Initializes the Vips library. Automatic initialization is performed when vips-ffm classes are used.

### Method
`static void init()`

### Note
Note that you do not usually need to call `init()` yourself, as initialisation is performed automatically when vips-ffm classes are used.
```

--------------------------------

### Get Image Double Property Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_double. This is used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_double$descriptor()
Function descriptor for: 
extern int vips_image_get_double(const VipsImage *image, const char *name, double *out)
```

--------------------------------

### Get VipsImage Blob Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_image_get_blob. This is typically used when setting up foreign function interfaces.

```java
static FunctionDescriptor
vips_image_get_blob$descriptor()
Function descriptor for: 
extern int vips_image_get_blob(const VipsImage *image, const char *name, const void **data, size_t *length)
```

--------------------------------

### VipsOption Constructors

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.html

This section details the static factory methods (constructors) for creating different types of VipsOption objects. Each option type can be initialized with a key, and some can also be initialized with a specific value.

```APIDOC
## VipsOption Constructors

This section details the static factory methods (constructors) for creating different types of VipsOption objects. Each option type can be initialized with a key, and some can also be initialized with a specific value.

### `VipsOption.Int`

Creates an integer option.

- `static VipsOption.Int Int(String key, Integer value)`: Creates an Int option with a key and an integer value.
- `static VipsOption.Int Int(String key)`: Creates an Int option with only a key.

### `VipsOption.Double`

Creates a double-precision floating-point option.

- `static VipsOption.Double Double(String key, Double value)`: Creates a Double option with a key and a double value.
- `static VipsOption.Double Double(String key)`: Creates a Double option with only a key.

### `VipsOption.Long`

Creates a long integer option.

- `static VipsOption.Long Long(String key, Long value)`: Creates a Long option with a key and a long value.
- `static VipsOption.Long Long(String key)`: Creates a Long option with only a key.

### `VipsOption.Boolean`

Creates a boolean option.

- `static VipsOption.Boolean Boolean(String key, boolean value)`: Creates a Boolean option with a key and a boolean value.
- `static VipsOption.Boolean Boolean(String key)`: Creates a Boolean option with only a key.

### `VipsOption.String`

Creates a string option.

- `static VipsOption.String String(String key, String value)`: Creates a String option with a key and a string value.
- `static VipsOption.String String(String key)`: Creates a String option with only a key.

### `VipsOption.Image`

Creates an image option.

- `static VipsOption.Image Image(String key, VImage value)`: Creates an Image option with a key and a VImage value.
- `static VipsOption.Image Image(String key)`: Creates an Image option with only a key.

### `VipsOption.Source`

Creates a source option.

- `static VipsOption.Source Source(String key, VSource value)`: Creates a Source option with a key and a VSource value.
- `static VipsOption.Source Source(String key)`: Creates a Source option with only a key.

### `VipsOption.Target`

Creates a target option.

- `static VipsOption.Target Target(String key, VTarget value)`: Creates a Target option with a key and a VTarget value.
- `static VipsOption.Target Target(String key)`: Creates a Target option with only a key.

### `VipsOption.Blob`

Creates a blob option.

- `static VipsOption.Blob Blob(String key, VBlob value)`: Creates a Blob option with a key and a VBlob value.
- `static VipsOption.Blob Blob(String key)`: Creates a Blob option with only a key.

### `VipsOption.ArrayDouble`

Creates an array of doubles option.

- `static VipsOption.ArrayDouble ArrayDouble(String key, List<Double> value)`: Creates an ArrayDouble option with a key and a list of doubles.
- `static VipsOption.ArrayDouble ArrayDouble(String key)`: Creates an ArrayDouble option with only a key.

### `VipsOption.ArrayInt`

Creates an array of integers option.

- `static VipsOption.ArrayInt ArrayInt(String key, List<Integer> value)`: Creates an ArrayInt option with a key and a list of integers.
- `static VipsOption.ArrayInt ArrayInt(String key)`: Creates an ArrayInt option with only a key.

### `VipsOption.ArrayImage`

Creates an array of images option.

- `static VipsOption.ArrayImage ArrayImage(String key, List<VImage> value)`: Creates an ArrayImage option with a key and a list of VImages.
- `static VipsOption.ArrayImage ArrayImage(String key)`: Creates an ArrayImage option with only a key.

### `VipsOption.Enum`

Creates an enum option.

- `static VipsOption.Enum Enum(String key, int value)`: Creates an Enum option with a key and an integer value.
- `static VipsOption.Enum Enum(String key, VEnum value)`: Creates an Enum option with a key and a VEnum value.
- `static VipsOption.Enum Enum(String key)`: Creates an Enum option with only a key.

### `VipsOption.Interpolate`

Creates an interpolation option.

- `static VipsOption.Interpolate Interpolate(String key, VInterpolate value)`: Creates an Interpolate option with a key and a VInterpolate value.
- `static VipsOption.Interpolate Interpolate(String key)`: Creates an Interpolate option with only a key.
```

--------------------------------

### newFromFile

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Creates a new VImage by loading it from a file path. This is the recommended method for loading images from disk.

```APIDOC
## newFromFile

### Description
Creates a new VImage by loading it from a file path.

### Method
`public static VImage newFromFile(Arena arena, String path, VipsOption... options)`

### Parameters
#### Path Parameters
- **arena** (Arena) - The arena that bounds resulting memory allocations during this operation
- **path** (String) - The file path to load the image from
- **options** (VipsOption...) - Array of VipsOption to apply to this operation

### Throws
- `VipsError`
```

--------------------------------

### Get Vips Foreign Save Function Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the function descriptor for vips_foreign_save, defining its signature for FFI calls.

```java
static FunctionDescriptor
vips_foreign_find_save$descriptor()
Function descriptor for: 
extern const char *vips_foreign_save(const char *filename)
```

--------------------------------

### newFromBytes (with option string)

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Creates a new VImage from raw bytes with an option string. Note: This method is inefficient and `newFromFile` or similar is preferred.

```APIDOC
## newFromBytes (with option string)

### Description
Creates a new VImage from raw bytes. Note that this is quite inefficient, use `newFromFile(java.lang.foreign.Arena, java.lang.String, app.photofox.vipsffm.VipsOption...)` and friends instead.

### Method
`public static VImage newFromBytes(Arena arena, byte[] bytes, String optionString, VipsOption... options)`

### Parameters
#### Path Parameters
- **arena** (Arena) - The arena that bounds resulting memory allocations during this operation
- **bytes** (byte[]) - The raw byte data of the image
- **optionString** (String) - A string containing options for loading
- **options** (VipsOption...) - Array of VipsOption to apply to this operation

### Throws
- `VipsError`
```

--------------------------------

### Get Vips Area Type Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_area_get_type function. Useful for direct memory access or interop.

```java
public static MemorySegment vips_area_get_type$address()
```

--------------------------------

### Create VipsTarget to Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a VipsTarget that writes to a file descriptor. Ensure the descriptor is valid and writable.

```c
extern VipsTarget *vips_target_new_to_descriptor(int descriptor)
```

--------------------------------

### Get Vips Area Data Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_area_get_data function. Useful for direct memory access or interop.

```java
public static MemorySegment vips_area_get_data$address()
```

--------------------------------

### Get Vips Object Unref Outputs Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_object_unref_outputs function. This is useful for direct memory operations.

```Java
public static MemorySegment vips_object_unref_outputs$address()
```

--------------------------------

### New Source From Target

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_source_new_from_target`. Creates a new VipsSource from a VipsTarget.

```java
public static MemorySegment source_new_from_target(Arena arena, MemorySegment target) throws VipsError
```

--------------------------------

### Get Vips Nickname Find Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_nickname_find function. This is useful for direct memory manipulation or interop.

```Java
public static MemorySegment vips_nickname_find$address()
```

--------------------------------

### VipsOption.Blob Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.Blob.html

Creates a new instance of the VipsOption.Blob record.

```APIDOC
## Blob Constructor

### Description
Creates an instance of a `Blob` record class.

### Parameters
* **key** (String) - The value for the `key` record component.
* **box** (AtomicReference<Optional<VBlob>>) - The value for the `box` record component.
```

--------------------------------

### Get Vips Type Find Address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Get the memory address for the vips_type_find function. This is useful for direct memory access or interop.

```Java
public static MemorySegment vips_type_find$address()
```

--------------------------------

### ppmload

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Loads a PPM/PBM/PGM/PFM file into a VIPS image.

```APIDOC
## ppmload

### Description
Reads a PPM/PBM/PGM/PFM file into a VIPS image. It can read 1, 8, 16 and 32 bit images, colour or monochrome, stored in ASCII or binary. One bit images become 8 bit VIPS images, with 0 and 255 for 0 and 1.

### Method
public static VImage ppmload(Arena arena, String filename, VipsOption... args)

### Parameters
- **arena** (Arena) - The arena that bounds resulting memory allocations during this operation
- **filename** (String) - Filename to load from
- **args** (Array of VipsOption) - Array of VipsOption to apply to this operation

### Optional arguments
- **flags** (VipsOption.Int) - Flags for this file
- **memory** (VipsOption.Boolean) - Force open via memory
- **access** (VipsOption.Enum) - `VipsAccess` Required access pattern for this file
- **fail-on** (VipsOption.Enum) - `VipsFailOn` Error level to fail on
- **revalidate** (VipsOption.Boolean) - Don't use a cached result for this operation
- **sequential** (VipsOption.Boolean) - Sequential read only
- **fail** (VipsOption.Boolean) - Fail on first warning
- **disc** (VipsOption.Boolean) - Open to disc

### Throws
`VipsError`
```

--------------------------------

### GValue Get Int Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the function descriptor for getting an integer value from a GValue. Used for defining function signatures.

```java
public static FunctionDescriptor g_value_get_int$descriptor()
```

```c
extern gint g_value_get_int(const GValue *value)
```

--------------------------------

### source_new_from_options

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to vips_source_new_from_options. Creates a new VipsSource from options string.

```APIDOC
## source_new_from_options

### Description
Creates a new VipsSource from options string.

### Method
public static MemorySegment source_new_from_options(Arena arena, String optionsString)

### Throws
`VipsError`
```

--------------------------------

### Create VipsImage from Memory (Copy)

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Creates a VipsImage from raw pixel data in memory, making a copy of the data. Use this if the original data might be modified or freed.

```java
public static MemorySegment image_new_from_memory_copy(Arena arena, MemorySegment data, long size, int width, int height, int bands, int format) throws VipsError
```

--------------------------------

### GValue Get Boolean Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the function descriptor for getting a boolean value from a GValue. Used for defining function signatures.

```java
public static FunctionDescriptor g_value_get_boolean$descriptor()
```

```c
extern gboolean g_value_get_boolean(const GValue *value)
```

--------------------------------

### VipsOption.Image Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.Image.html

Creates a new instance of the VipsOption.Image record. This record is used to hold an image value associated with a specific key.

```APIDOC
## VipsOption.Image Constructor

### Description
Creates an instance of a `Image` record class.

### Parameters
#### Parameters
- **key** (String) - The value for the `key` record component.
- **box** (AtomicReference<Optional<VImage>>) - The value for the `box` record component.
```

--------------------------------

### GValue Get Object Handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the downcall method handle for getting a GObject from a GValue. Used for invoking the native function.

```java
public static MethodHandle g_value_get_object$handle()
```

```c
extern gpointer g_value_get_object(const GValue *value)
```

--------------------------------

### VIPS_OPERATION_COMPLEXGET_LAST Constant

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Marks the last valid complex get operation flag. Useful for iterating or validating complex get operations.

```c
static int
VIPS_OPERATION_COMPLEXGET_LAST()
Copy ```
enum <anonymous>.VIPS_OPERATION_COMPLEXGET_LAST = 2

```
```

--------------------------------

### Find Load Format from Source

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Finds the appropriate Vips load operation for a VipsSource. Requires an Arena and the VipsSource object. Can throw VipsError.

```java
public static String foreign_find_load_source(MemorySegment source) throws VipsError
```

--------------------------------

### GValue Get Int Handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the downcall method handle for getting an integer value from a GValue. Used for invoking the native function.

```java
public static MethodHandle g_value_get_int$handle()
```

```c
extern gint g_value_get_int(const GValue *value)
```

--------------------------------

### New Target To File

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_target_new_to_file`. Creates a new VipsTarget that writes to a file.

```java
public static MemorySegment target_new_to_file(Arena arena, String filenameString) throws VipsError
```

--------------------------------

### VipsOption.Int Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.Int.html

Creates a new instance of the VipsOption.Int record. This record represents an integer option with a key and a boxed value.

```APIDOC
## VipsOption.Int Constructor

### Description
Creates an instance of a `Int` record class.

### Parameters
- **key** (String) - The key for the `key` record component.
- **box** (AtomicReference<Optional<Integer>>) - The value for the `box` record component.
```

--------------------------------

### GValue Get Boolean Handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Provides the downcall method handle for getting a boolean value from a GValue. Used for invoking the native function.

```java
public static MethodHandle g_value_get_boolean$handle()
```

```c
extern gboolean g_value_get_boolean(const GValue *value)
```

--------------------------------

### VipsHelper Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Initializes a new instance of the VipsHelper class.

```APIDOC
## VipsHelper Constructor

### Description
Initializes a new instance of the VipsHelper class.

### Method
public VipsHelper()
```

--------------------------------

### Get N_Values Field Value

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_GEnumClass.html

Retrieves the integer value of the 'n_values' field from a GEnumClass struct instance. Use this to get the count of enum values.

```java
public static int n_values(MemorySegment struct)
```

--------------------------------

### Create VipsSource from Target

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a VipsSource from a VipsTarget object. This is typically used for reading from a target stream.

```c
extern VipsSource *vips_source_new_from_target(VipsTarget *target)
```

--------------------------------

### Get Ref String Handle

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Obtains a downcall method handle for vips_value_get_ref_string. This allows calling the C function to get a referenced string and its length from Java.

```java
public static MethodHandle vips_value_get_ref_string$handle()
```

```c
extern const char *vips_value_get_ref_string(const GValue *value, size_t *length)
```

--------------------------------

### vips_source_new_from_options

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsSource from options string.

```APIDOC
## vips_source_new_from_options

### Description
Creates a new VipsSource from an options string.

### Method
extern VipsSource *
vips_source_new_from_options(const char *options)

### Parameters
#### Path Parameters
- **options** (const char *) - Required - The options string.
```

--------------------------------

### Install jemalloc on Ubuntu

Source: https://vipsffm.photofox.app/index.html

Install jemalloc on Ubuntu systems to potentially improve memory allocation performance for long-running, multithreaded Java applications using libvips.

```bash
apt install libjemalloc2

```

--------------------------------

### VipsOption.Target Constructor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsOption.Target.html

Creates a new instance of the Target record class with the provided key and box.

```APIDOC
## Target Constructor

### Description
Creates an instance of a `Target` record class.

### Parameters
* `key` (String) - The value for the `key` record component.
* `box` (AtomicReference<Optional<VTarget>>) - The value for the `box` record component.
```

--------------------------------

### Getting the unsafe struct address

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VTarget.html

Gets the raw MemorySegment (C pointer) for the VipsTarget struct. This is intended for advanced use cases where direct memory access is required.

```APIDOC
## MemorySegment getUnsafeStructAddress()

### Description
Gets the raw `MemorySegment` (C pointer) for this VipsTarget struct
The memory address' lifetime is bound to the scope of the arena that created it
Usage of the memory address is strongly discouraged, but it is available if some functionality is missing, and you need to use it with `VipsHelper`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```java
// Example usage (assuming vipsTarget is an instance of VTarget)
MemorySegment structAddress = vipsTarget.getUnsafeStructAddress();
```

### Response
#### Success Response (MemorySegment)
- Returns the `MemorySegment` representing the C pointer to the VipsTarget struct.

#### Response Example
```java
// MemorySegment object representing the raw memory address
```
```

--------------------------------

### Initialization and Shutdown

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Methods for initializing and shutting down the VIPS library.

```APIDOC
## init

### Description
Initializes the VIPS library.

### Method
`public static int init(Arena arena, String argv0String) throws VipsError`

### Parameters
* **arena** (Arena) - The memory arena to use.
* **argv0String** (String) - The name of the program (typically `argv[0]`).

### Returns
* (int) - Returns 0 on success, non-zero on failure.

### Throws
* `VipsError` - If an error occurs during initialization.

## shutdown

### Description
Shuts down the VIPS library, freeing resources.

### Method
`public static void shutdown() throws VipsError`

### Throws
* `VipsError` - If an error occurs during shutdown.
```

--------------------------------

### vips_target_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Gets the GType for VipsTarget.

```APIDOC
## vips_target_get_type

### Description
Gets the GType for VipsTarget.

### Method
extern GType vips_target_get_type()

### Parameters
None.
```

--------------------------------

### vips_source_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Gets the GType of a VipsSource.

```APIDOC
## vips_source_get_type()

### Description
Retrieves the GType (GObject type) identifier for VipsSource. This is useful for type checking and introspection within the GObject system.

### Signature
`extern GType vips_source_get_type()`
```

--------------------------------

### Create New VipsImage

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new, empty VipsImage. This is often the first step before loading or generating image data.

```c
extern VipsImage *vips_image_new()
```

--------------------------------

### VipsRaw: VIPS_EXEEXT

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Defines the executable extension for VIPS. Typically an empty string.

```c
#define VIPS_EXEEXT ""

```

--------------------------------

### array_image_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Gets the GType for VipsArrayImage.

```APIDOC
## array_image_get_type

### Description
Gets the GType for VipsArrayImage.

### Method
public static long array_image_get_type()

### Throws
`VipsError`
```

--------------------------------

### array_int_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Gets the GType for VipsArrayInt.

```APIDOC
## array_int_get_type

### Description
Gets the GType for VipsArrayInt.

### Method
public static long array_int_get_type()

### Throws
`VipsError`
```

--------------------------------

### array_double_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Gets the GType for VipsArrayDouble.

```APIDOC
## array_double_get_type

### Description
Gets the GType for VipsArrayDouble.

### Method
public static long array_double_get_type()

### Throws
`VipsError`
```

--------------------------------

### vips_init

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Initializes the Vipsffm library. This function must be called before using any other Vipsffm functions.

```APIDOC
## vips_init

### Description
Initializes the Vipsffm library.

### Signature
```c
extern int vips_init(const char *argv0)
```
```

--------------------------------

### blob_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Gets the GType for VipsBlob.

```APIDOC
## blob_get_type

### Description
Gets the GType for VipsBlob.

### Method
public static long blob_get_type()

### Throws
`VipsError`
```

--------------------------------

### thumbnail

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html

Creates a thumbnail from a file.

```APIDOC
## thumbnail

### Description
Make a thumbnail from a file.

### Method
N/A (static method or constructor-like behavior)

### Parameters
- **arena** (Arena) - Required - The arena for memory management.
- **filename** (String) - Required - The path to the image file.
- **width** (int) - Required - The desired width of the thumbnail.
- **args** (VipsOption...) - Optional - Additional options for the operation.
```

--------------------------------

### area_get_type

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Gets the GType for VipsArea.

```APIDOC
## area_get_type

### Description
Gets the GType for VipsArea.

### Method
public static long area_get_type()

### Throws
`VipsError`
```

--------------------------------

### New Source From Descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Binds to `vips_source_new_from_descriptor`. Creates a new VipsSource from a file descriptor.

```java
public static MemorySegment source_new_from_descriptor(Arena arena, int descriptor) throws VipsError
```

--------------------------------

### Create VipsTarget from File Path

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsTarget for writing image data to a specified file path. Ensure the path is valid and writable.

```c
extern VipsTarget *vips_target_new_to_file(const char *filename)
```

--------------------------------

### Get output_buffer

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_VipsTarget.html

Getter for the output_buffer field.

```java
public static MemorySegment output_buffer(MemorySegment struct)
```

--------------------------------

### vips_source_new_from_descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsSource from a file descriptor.

```APIDOC
## vips_source_new_from_descriptor(int descriptor)

### Description
Creates a new VipsSource object that reads from a given file descriptor. This is useful for handling input from files or pipes.

### Parameters
#### Path Parameters
- **descriptor** (int) - Required - The file descriptor to read from.

### Signature
`extern VipsSource *vips_source_new_from_descriptor(int descriptor)`
```

--------------------------------

### Get blob

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_VipsTarget.html

Getter for the blob field.

```java
public static MemorySegment blob(MemorySegment struct)
```

--------------------------------

### vips_source_new_from_descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsSource from a file descriptor.

```APIDOC
## vips_source_new_from_descriptor

### Description
Creates a new VipsSource from a file descriptor.

### Method
extern VipsSource *
vips_source_new_from_descriptor(int descriptor)

### Parameters
#### Path Parameters
- **descriptor** (int) - Required - The file descriptor to create the source from.
```

--------------------------------

### Get memory_buffer

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/_VipsTarget.html

Getter for the memory_buffer field.

```java
public static MemorySegment memory_buffer(MemorySegment struct)
```

--------------------------------

### image_new

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html

Creates a new, empty VipsImage.

```APIDOC
## image_new

### Description
Creates a new, empty VipsImage.

### Signature
`static MemorySegment image_new(Arena arena)`

### Binding For
`VipsImage *vips_image_new()`
```

--------------------------------

### vips_source_new_from_file

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Creates a new VipsSource from a file path.

```APIDOC
## vips_source_new_from_file

### Description
Creates a new VipsSource from a file path.

### Method
extern VipsSource *
vips_source_new_from_file(const char *filename)

### Parameters
#### Path Parameters
- **filename** (const char *) - Required - The path to the file.
```

--------------------------------

### vips_source_new_from_descriptor$descriptor

Source: https://vipsffm.photofox.app/app.photofox.vipsffm/app/photofox/vipsffm/jextract/VipsRaw.html

Gets the function descriptor for vips_source_new_from_descriptor.

```APIDOC
## vips_source_new_from_descriptor$descriptor()

### Description
Returns a function descriptor for the `vips_source_new_from_descriptor` function. This descriptor contains information about the function's signature and calling convention, useful for dynamic function invocation.

### Signature
`static FunctionDescriptor vips_source_new_from_descriptor$descriptor()`
```
Tokens:
Raw