Class VTarget

java.lang.Object

app.photofox.vipsffm.VTarget

Direct Known Subclasses:

VCustomTarget

public sealed class VTarget
extends Object
permits VCustomTarget

Represents a VipsTarget

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

Use its static helper methods to create new targets

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)
VBlob	getBlob()	Only valid for memory-backed targets (eg via newToMemory(Arena))
MemorySegment	getUnsafeStructAddress()	Gets the raw MemorySegment (C pointer) for this VipsTarget struct
int	hashCode()
static VTarget	newFromOutputStream(Arena arena, OutputStream stream)	Create a new VipsTarget pointed at a Java OutputStream The provided OutputStream is coupled to the arena's lifetime, and closed when its scope ends Note that you can directly write an image to an OutputStream using VImage.writeToStream(java.io.OutputStream, java.lang.String, app.photofox.vipsffm.VipsOption...) This target can also be used with (for example) VImage.writeToTarget(app.photofox.vipsffm.VTarget, java.lang.String, app.photofox.vipsffm.VipsOption...)
static VTarget	newToDescriptor(Arena arena, int descriptor)	Create a new target pointed at a file descriptor
static VTarget	newToFile(Arena arena, String filename)	Create a new target pointed at an output file
static VTarget	newToMemory(Arena arena)	Create a new memory-backed VipsTarget

Methods inherited from class java.lang.Object

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

Method Details

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getUnsafeStructAddress

public MemorySegment getUnsafeStructAddress()

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

newToDescriptor

public static VTarget newToDescriptor(Arena arena,
 int descriptor)
                               throws VipsError

Create a new target pointed at a file descriptor

This target can be used with (for example) VImage.writeToTarget(app.photofox.vipsffm.VTarget, java.lang.String, app.photofox.vipsffm.VipsOption...)

Throws:

VipsError

newToFile

public static VTarget newToFile(Arena arena,
 String filename)
                         throws VipsError

Create a new target pointed at an output file

This target can be used with (for example) VImage.writeToTarget(app.photofox.vipsffm.VTarget, java.lang.String, app.photofox.vipsffm.VipsOption...)

Throws:

VipsError

newToMemory

public static VTarget newToMemory(Arena arena)
                           throws VipsError

Create a new memory-backed VipsTarget

This target can be used with (for example) VImage.writeToTarget(app.photofox.vipsffm.VTarget, java.lang.String, app.photofox.vipsffm.VipsOption...)

After writing to this target, you can also retrieve the backing VBlob with getBlob()

Throws:

VipsError

getBlob

public VBlob getBlob()
              throws VipsError

Only valid for memory-backed targets (eg via newToMemory(Arena))

Returns the contents of the backing VBlob

Throws:

VipsError

newFromOutputStream

public static VTarget newFromOutputStream(Arena arena,
 OutputStream stream)
                                   throws VipsError

Create a new VipsTarget pointed at a Java OutputStream

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

Note that you can directly write an image to an OutputStream using VImage.writeToStream(java.io.OutputStream, java.lang.String, app.photofox.vipsffm.VipsOption...)

This target can also be used with (for example) VImage.writeToTarget(app.photofox.vipsffm.VTarget, java.lang.String, app.photofox.vipsffm.VipsOption...)

Throws:

VipsError