Class VSource

java.lang.Object

app.photofox.vipsffm.VSource

Direct Known Subclasses:

VCustomSource

public sealed class VSource
extends Object
permits VCustomSource

Represents a VipsSource

Its constructor is package private to prevent leaking MemorySegments in to the vips-ffm API

Use its static helper methods to create new sources

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MemorySegment	getUnsafeAddress()	Deprecated, for removal: This API element is subject to removal in a future version. See getUnsafeStructAddress()
MemorySegment	getUnsafeStructAddress()	Gets the raw MemorySegment (C pointer) for this VipsSource struct
int	hashCode()
static VSource	newFromBlob(Arena arena, VBlob blob)	Create a new VSource from a VBlob, usually received from a Vips operation
static VSource	newFromBytes(Arena arena, byte[] bytes)	Create a new VSource directly from some bytes
static VSource	newFromDescriptor(Arena arena, int descriptor)	Create a new VSource from a file descriptor
static VSource	newFromFile(Arena arena, String filename)	Create a new VSource from a file path
static VSource	newFromInputStream(Arena arena, InputStream stream)	Creates a new VSource from a Java InputStream The provided InputStream is coupled to the arena's lifetime, and closed when its scope ends Note that you can read an image directly from an InputStream using VImage.newFromStream(java.lang.foreign.Arena, java.io.InputStream, java.lang.String, app.photofox.vipsffm.VipsOption...) This stream does not support seeking, because InputStream does not support it, so cannot be maximally efficient - but it is still likely more efficient than taking a full intermediate copy of bytes
static VSource	newFromOptions(Arena arena, String options)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getUnsafeAddress

@Deprecated(since="0.5.10",
            forRemoval=true)
public MemorySegment getUnsafeAddress()

Deprecated, for removal: This API element is subject to removal in a future version.

See getUnsafeStructAddress()

getUnsafeStructAddress

public MemorySegment getUnsafeStructAddress()

Gets the raw MemorySegment (C pointer) for this VipsSource 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

newFromDescriptor

public static VSource newFromDescriptor(Arena arena,
 int descriptor)
                                 throws VipsError

Create a new VSource from a file descriptor

Throws:

VipsError

newFromFile

public static VSource newFromFile(Arena arena,
 String filename)
                           throws VipsError

Create a new VSource from a file path

Throws:

VipsError

newFromBlob

public static VSource newFromBlob(Arena arena,
 VBlob blob)
                           throws VipsError

Create a new VSource from a VBlob, usually received from a Vips operation

Throws:

VipsError

newFromBytes

public static VSource newFromBytes(Arena arena,
 byte[] bytes)
                            throws VipsError

Create a new VSource directly from some bytes

Note that this makes a full copy of the data, which is inefficient - prefer VImage.newFromFile(java.lang.foreign.Arena, java.lang.String, app.photofox.vipsffm.VipsOption...) and friends

Throws:

VipsError

newFromOptions

public static VSource newFromOptions(Arena arena,
 String options)
                              throws VipsError

Throws:

VipsError

newFromInputStream

public static VSource newFromInputStream(Arena arena,
 InputStream stream)
                                  throws VipsError

Creates a new VSource from a Java InputStream

The provided InputStream is coupled to the arena's lifetime, and closed when its scope ends

Note that you can read an image directly from an InputStream using VImage.newFromStream(java.lang.foreign.Arena, java.io.InputStream, java.lang.String, app.photofox.vipsffm.VipsOption...)

This stream does not support seeking, because InputStream does not support it, so cannot be maximally efficient - but it is still likely more efficient than taking a full intermediate copy of bytes

Throws:

VipsError