All notable changes to NetVips will be documented in this file. See here for the changes to the pre-compiled binaries of libvips.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+ReadOnlySpan<T> / ReadOnlyMemory<T> overloads (#225).net6.0) and .NET Framework 4.5.2 (net452) moving forward.
+See https://devblogs.microsoft.com/dotnet/the-future-of-net-standard/ for more information.VOption merge (#228).Image.FindLoad() works on UTF-8 strings (#210).Image.NewFromMemory() (#177).image.Invalidate() to drop caches on an image, and any downstream images.NetVips.Shutdown() to finalize the internal leak checker and profiler.NetVips.BlockUntrusted() and Operation.Block() for blocking operations at runtime.image.SignalHandlersDisconnectByFunc() and image.SignalHandlersDisconnectByData() for disconnecting signal handlers that match.image.OnPostClose remove event accessor.VipsSaveable enum.VipsSaveable enum.image.SignalHandlerDisconnect() for disconnecting a signal handler.ModuleInit.Fody dependency in favor of the [ModuleInitializer] attribute.image.WriteToBuffer() tries to use the new target API first.Span<T> throughout the codebase (#131).ForeignPngFilter enum (#106).image.AddAlpha() operation (#116).image.Mutate() function for creating an MutableImage (#119).Image.*loadStream() and image.*saveStream() earlier (#78).System.Buffers.ArrayPool.Image.NewFromStream() and Image.NewFromSource() on Windows 32-bit.Image.NewFromStream() too early (#58).image.SetType() function has been renamed to image.Set().Image.Sum() function uses the params keyword.Operation.GenerateImageClass() has moved to the samples directory.Image.FindLoad(), Image.FindLoadBuffer() and Image.FindLoadStream()) (#37).image.PageHeight property for retrieving the page height for multi-page images.UseGlobalLibvips property since the bundled libvips binaries were moved to the NetVips.Native package.Base.Version() by caching the libvips version as soon as the assembly is loaded.LibvipsOutputBase property to specify the subdirectory (within your project's output directory) where the libvips binaries are copied to (#20).ModuleInitializer (used to initialize libvips once the assembly is loaded) (#15, #20).LibvipsDLLPath property.image.Contains() helper (to check if the image contains an property of metadata).All notable changes to the pre-compiled binaries of libvips will be documented in this file. The version number of these NuGet packages is in sync with libvips' version number. The changes of libvips are documented here.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
-If you would like to see what's changed, please visit the release notes of libvips:
+https://www.libvips.org/2024/10/10/What's-new-in-8.16.html
NetVips.Native.win-x64.net452 and NetVips.Native.win-x86.net452 compat packages.If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.15.3
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.15.2
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.15.1
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2023/10/10/What's-new-in-8.15.html
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.14.5
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.14.4
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.14.3
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2022/12/22/What's-new-in-8.14.html
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.13.2
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.13.1
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2022/05/28/What's-new-in-8.13.html
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.12.2
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2021/11/14/What's-new-in-8.12.html
netstandard2.1 group (#151).If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.11.4
System.DllNotFoundException on .NET Framework (#136).If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.11.3
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2021/06/04/What's-new-in-8.11.html
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.10.6
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.10.5
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.10.1
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2020/06/18/What's-new-in-8.10.html
Requires NetVips v1.2.3.
-If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.9.2
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.9.1
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2019/12/11/What's-new-in-8.9.html
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.8.4
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.8.3
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.8.2
If you would like to see what's changed, please visit the release notes of libvips:
https://github.com/libvips/libvips/releases/tag/v8.8.1
If you would like to see what's changed, please visit the release notes of libvips:
https://www.libvips.org/2019/04/22/What's-new-in-8.8.html
jpeg-turbo instead than jpeg (lovell/package-libvips-darwin#3).Signals that can be used on an Image. See SignalConnect<T>(string, T, IntPtr).
+Signals that can be used on an Image. See SignalConnect<T>(string, T, nint).
Connects a callback function (callback) to a signal on this object.
public ulong SignalConnect<T>(string detailedSignal, T callback, IntPtr data = default) where T : notnullpublic ulong SignalConnect<T>(string detailedSignal, T callback, nint data = 0) where T : notnull| IntPtr | +nint | data | Data to pass to handler calls. |
@@ -327,13 +327,13 @@
| IntPtr | +nint | data | The data of the handlers. |
@@ -370,14 +370,14 @@
Disconnects all handlers from this object that match func and
data.
public uint SignalHandlersDisconnectByFunc<T>(T func, IntPtr data = default) where T : notnullpublic uint SignalHandlersDisconnectByFunc<T>(T func, nint data = 0) where T : notnull| IntPtr | +nint | data | The data of the handlers. |
diff --git a/api/NetVips.GValue.html b/api/NetVips.GValue.html
index af45b33..7b7653b 100644
--- a/api/NetVips.GValue.html
+++ b/api/NetVips.GValue.html
@@ -140,7 +140,7 @@
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | -- |
The fundamental type for VipsBandFormat. See Enums.BandFormat.
-public static readonly IntPtr BandFormatType| Type | -Description | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint |
| IntPtr | +nint | The GType of this GValue. |
| IntPtr | +nint | gtype | Type the GValue should hold values of. |
diff --git a/api/NetVips.Image.html b/api/NetVips.Image.html
index 0e5fff7..6a552da 100644
--- a/api/NetVips.Image.html
+++ b/api/NetVips.Image.html
@@ -100,16 +100,16 @@
| Type | -Name | -Description | -
|---|---|---|
| int? | -maxTiles | -Maximum number of tiles to cache. - |
-
| int? | -tileHeight | -Tile height in pixels. - |
-
| int? | -tileWidth | -Tile width in pixels. - |
-
| Type | -Description | -
|---|---|
| Image | -A new Image. - |
-
using Image @out = in.Cache(maxTiles: int, tileHeight: int, tileWidth: int);Canny edge detector.
@@ -2918,6 +2860,58 @@Clamp values of an image.
+public Image Clamp(double? min = null, double? max = null)| Type | +Name | +Description | +
|---|---|---|
| double? | +min | +Minimum value. + |
+
| double? | +max | +Maximum value. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
using Image @out = in.Clamp(min: double, max: double);Convert to a new colorspace.
@@ -6651,6 +6645,53 @@For example "VipsForeignLoadJpegBuffer". You can use this to work out what options to pass to NewFromBuffer(char[], string, Access?, FailOn?, VOption).
+Find the name of the load operation vips will use to load a buffer.
+public static string FindLoadBuffer(ReadOnlySpan<byte> data)| Type | +Name | +Description | +
|---|---|---|
| ReadOnlySpan<byte> | +data | +The buffer to test. + |
+
| Type | +Description | +
|---|---|
| string | +The name of the load operation, or null. + |
+
For example "VipsForeignLoadJpegBuffer". You can use this to work out what +options to pass to NewFromBuffer(ReadOnlySpan<byte>, string, Access?, FailOn?, VOption).
public IntPtr GetTypeOf(string name)public nint GetTypeOf(string name)| IntPtr | -A new instance of IntPtr initialized to the GType or + | nint | +A new instance of nint initialized to the GType or Zero if the property does not exist. |
| int | y | Point to read. + |
+
+
| bool? | +unpackComplex | +Complex pixels should be unpacked. |
double[] outArray = in.Getpoint(x, y);double[] outArray = in.Getpoint(x, y, unpackComplex: bool);Filename to load from.
+Filename to save to.
Load JPEG-XL image.
public static Image Jxlload(string filename, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image Jxlload(string filename, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Enums.ForeignFlags | flags | Flags for this file. + |
+
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.Jxlload(filename, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.Jxlload(filename, out var flags, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image Jxlload(string filename, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image Jxlload(string filename, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| string | filename | Filename to load from. + |
+
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.Jxlload(filename, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.Jxlload(filename, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image JxlloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image JxlloadBuffer(byte[] buffer, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Enums.ForeignFlags | flags | Flags for this file. + |
+
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.JxlloadBuffer(buffer, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.JxlloadBuffer(buffer, out var flags, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image JxlloadBuffer(byte[] buffer, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image JxlloadBuffer(byte[] buffer, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| byte[] | buffer | Buffer to load from. + |
+
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.JxlloadBuffer(buffer, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.JxlloadBuffer(buffer, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image JxlloadSource(Source source, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image JxlloadSource(Source source, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Enums.ForeignFlags | flags | Flags for this file. + |
+
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.JxlloadSource(source, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.JxlloadSource(source, out var flags, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image JxlloadSource(Source source, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image JxlloadSource(Source source, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| bool? | -memory | -Force open via memory. - |
-
| Enums.Access? | -access | -Required access pattern for this file. - |
-
| Enums.FailOn? | -failOn | -Error level to fail on. - |
-
| bool? | -revalidate | -Don't use a cached result for this operation. - |
-
| Type | -Description | -
|---|---|
| Image | -A new Image. - |
-
using Image @out = NetVips.Image.JxlloadSource(source, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
-public static Image JxlloadStream(Stream stream, out Enums.ForeignFlags flags, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Type | -Name | -Description | -|||
|---|---|---|---|---|---|
| Stream | -stream | -Stream to load from. + | int? | +page | +First page to load. |
| Enums.ForeignFlags | -flags | -Flags for this file. + | int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.JxlloadStream(stream, out var flags, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.JxlloadSource(source, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
public static Image JxlloadStream(Stream stream, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)public static Image JxlloadStream(Stream stream, out Enums.ForeignFlags flags, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Stream | stream | Stream to load from. + |
+
+
| Enums.ForeignFlags | +flags | +Flags for this file. + |
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. + |
+
| bool? | +memory | +Force open via memory. + |
+
| Enums.Access? | +access | +Required access pattern for this file. + |
+
| Enums.FailOn? | +failOn | +Error level to fail on. + |
+
| bool? | +revalidate | +Don't use a cached result for this operation. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
using Image @out = NetVips.Image.JxlloadStream(stream, out var flags, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Load JPEG-XL image.
+public static Image JxlloadStream(Stream stream, int? page = null, int? n = null, bool? memory = null, Enums.Access? access = null, Enums.FailOn? failOn = null, bool? revalidate = null)| Type | +Name | +Description | +
|---|---|---|
| Stream | +stream | +Stream to load from. + |
+
| int? | +page | +First page to load. + |
+
| int? | +n | +Number of pages to load, -1 for all. |
using Image @out = NetVips.Image.JxlloadStream(stream, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);using Image @out = NetVips.Image.JxlloadStream(stream, page: int, n: int, memory: bool, access: Enums.Access, failOn: Enums.FailOn, revalidate: bool);Filename to load from.
+Filename to save to.
Maximum of a pair of images.
+public Image Maxpair(Image right)| Type | +Name | +Description | +
|---|---|---|
| Image | +right | +Right-hand image argument. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
using Image @out = left.Maxpair(right);Measure a set of patches on a color chart.
@@ -19415,6 +19604,52 @@Minimum of a pair of images.
+public Image Minpair(Image right)| Type | +Name | +Description | +
|---|---|---|
| Image | +right | +Right-hand image argument. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
using Image @out = left.Minpair(right);Morphology operation.
@@ -21010,6 +21245,95 @@This behaves exactly as NewFromFile(string, bool?, Access?, FailOn?, VOption), but the image is loaded from the memory object rather than from a file. The memory object can be a string or buffer.
+| Type | +Condition | +
|---|---|
| VipsException | +If unable to load from |
+
Load a formatted image from memory.
+public static Image NewFromBuffer(ReadOnlySpan<byte> data, string strOptions = "", Enums.Access? access = null, Enums.FailOn? failOn = null, VOption kwargs = null)| Type | +Name | +Description | +
|---|---|---|
| ReadOnlySpan<byte> | +data | +The memory object to load the image from. + |
+
| string | +strOptions | +Load options as a string. Use Empty for no options. + |
+
| Enums.Access? | +access | +Hint the expected access pattern for the image. + |
+
| Enums.FailOn? | +failOn | +The type of error that will cause load to fail. By +default, loaders are permissive, that is, None. + |
+
| VOption | +kwargs | +Optional options that depend on the load operation. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
This behaves exactly as NewFromFile(string, bool?, Access?, FailOn?, VOption), but the image is +loaded from the memory object rather than from a file. The memory +object can be a string or buffer.
Wrap an image around a memory area.
public static Image NewFromMemory(IntPtr data, ulong size, int width, int height, int bands, Enums.BandFormat format)public static Image NewFromMemory(nint data, ulong size, int width, int height, int bands, Enums.BandFormat format)| IntPtr | +nint | data | A unmanaged block of memory. |
@@ -21540,7 +21864,7 @@
Like NewFromMemory(IntPtr, ulong, int, int, int, BandFormat), but libvips +
Like NewFromMemory(nint, ulong, int, int, int, BandFormat), but libvips will make a copy of the memory area. This means more memory use and an extra copy operation, but is much simpler and safer.
public static Image NewFromMemoryCopy(IntPtr data, ulong size, int width, int height, int bands, Enums.BandFormat format)public static Image NewFromMemoryCopy(nint data, ulong size, int width, int height, int bands, Enums.BandFormat format)| IntPtr | +nint | data | A unmanaged block of memory. |
@@ -21645,6 +21969,203 @@
| VipsException | If unable to make image from |
+
Like NewFromMemory<T>(ReadOnlyMemory<T>, int, int, int, BandFormat), but +for ReadOnlySpan<T>, so we must copy as it could be allocated on the stack.
+public static Image NewFromMemoryCopy<T>(ReadOnlySpan<T> data, int width, int height, int bands, Enums.BandFormat format) where T : unmanaged| Type | +Name | +Description | +
|---|---|---|
| ReadOnlySpan<T> | +data | ++ | +
| int | +width | +Image width in pixels. + |
+
| int | +height | +Image height in pixels. + |
+
| int | +bands | +Number of bands. + |
+
| Enums.BandFormat | +format | +Band format. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
| Name | +Description | +
|---|---|
| T | ++ |
| Type | +Condition | +
|---|---|
| VipsException | +If unable to make image from |
+
Wrap an image around a memory array.
+public static Image NewFromMemory<T>(ReadOnlyMemory<T> data, int width, int height, int bands, Enums.BandFormat format) where T : unmanaged| Type | +Name | +Description | +
|---|---|---|
| ReadOnlyMemory<T> | +data | ++ | +
| int | +width | +Image width in pixels. + |
+
| int | +height | +Image height in pixels. + |
+
| int | +bands | +Number of bands. + |
+
| Enums.BandFormat | +format | +Band format. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
| Name | +Description | +
|---|---|
| T | ++ |
| Type | +Condition | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| VipsException | +If unable to make image from |
| int | -fd | -File descriptor to write to. + | Enums.ForeignKeep? | +keep | +Which metadata to retain. + |
+
| double[] | +background | +Background value. + |
+ |||
| int? | +pageHeight | +Set page height for multipage save. + |
+ |||
| string | +profile | +Filename of ICC profile to embed. + |
+
| Type | +Description | +
|---|---|
| byte[] | +An array of bytes. + |
+
byte[] buffer = in.RawsaveBuffer(keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Write raw image to stream.
+public void RawsaveStream(Stream stream, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| Type | +Name | +Description | +
|---|---|---|
| Stream | +stream | +Stream to save to. |
in.RawsaveFd(fd, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);in.RawsaveStream(stream, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Write raw image to target.
+public void RawsaveTarget(Target target, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| Type | +Name | +Description | +
|---|---|---|
| Target | +target | +Target to save to. + |
+
| Enums.ForeignKeep? | +keep | +Which metadata to retain. + |
+
| double[] | +background | +Background value. + |
+
| int? | +pageHeight | +Set page height for multipage save. + |
+
| string | +profile | +Filename of ICC profile to embed. + |
+
in.RawsaveTarget(target, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Rotate anticlockwise by this many degrees.
+Rotate clockwise by this many degrees.
using Image @out = in.Scharr();Create an SDF image.
+public static Image Sdf(int width, int height, Enums.SdfShape shape, double? r = null, double[] a = null, double[] b = null, double[] corners = null)| Type | +Name | +Description | +
|---|---|---|
| int | +width | +Image width in pixels. + |
+
| int | +height | +Image height in pixels. + |
+
| Enums.SdfShape | +shape | +SDF shape to create. + |
+
| double? | +r | +Radius. + |
+
| double[] | +a | +Point a. + |
+
| double[] | +b | +Point b. + |
+
| double[] | +corners | +Corner radii. + |
+
| Type | +Description | +
|---|---|
| Image | +A new Image. + |
+
using Image @out = NetVips.Image.Sdf(width, height, shape, r: double, a: double[], b: double[], corners: double[]);Check sequential access.
@@ -29306,13 +30027,13 @@using Image @out = in.Sign();Connects a callback function (callback) to a signal on this image.
public ulong SignalConnect(Enums.Signals signal, Image.EvalDelegate callback, IntPtr data = default)public ulong SignalConnect(Enums.Signals signal, Image.EvalDelegate callback, nint data = 0)| IntPtr | +nint | data | Data to pass to handler calls. |
@@ -29407,7 +30128,7 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| double? | angle | -Rotate anticlockwise by this many degrees. + | Rotate clockwise by this many degrees. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| int? | level | -ZSTD compression level. + | Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| int? | level | -ZSTD compression level. + | Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| int? | level | -ZSTD compression level. + | Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| int? | level | -ZSTD compression level. + | Deflate (1-9, default 6) or ZSTD (1-22, default 9) compression level. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| int? | effort | Level of CPU effort to reduce file size. + |
+
+
| int? | +targetSize | +Desired target size in bytes. |
| bool? | mixed | Allow mixed encoding (might reduce file size). + |
+
| bool? | +smartDeblock | +Enable auto-adjusting of the deblocking filter. + |
+
| int? | +passes | +Number of entropy-analysis passes (in [1..10]). |
in.Webpsave(filename, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, mixed: bool, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);in.Webpsave(filename, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, targetSize: int, mixed: bool, smartDeblock: bool, passes: int, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Save as WebP.
public byte[] WebpsaveBuffer(int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, bool? mixed = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)public byte[] WebpsaveBuffer(int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, int? targetSize = null, bool? mixed = null, bool? smartDeblock = null, int? passes = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| int? | effort | Level of CPU effort to reduce file size. + |
+
+
| int? | +targetSize | +Desired target size in bytes. |
| bool? | mixed | Allow mixed encoding (might reduce file size). + |
+
| bool? | +smartDeblock | +Enable auto-adjusting of the deblocking filter. + |
+
| int? | +passes | +Number of entropy-analysis passes (in [1..10]). |
byte[] buffer = in.WebpsaveBuffer(q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, mixed: bool, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);byte[] buffer = in.WebpsaveBuffer(q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, targetSize: int, mixed: bool, smartDeblock: bool, passes: int, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Save image to webp mime.
public void WebpsaveMime(int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, bool? mixed = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)public void WebpsaveMime(int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, int? targetSize = null, bool? mixed = null, bool? smartDeblock = null, int? passes = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| int? | effort | Level of CPU effort to reduce file size. + |
+
+
| int? | +targetSize | +Desired target size in bytes. |
| bool? | mixed | Allow mixed encoding (might reduce file size). + |
+
| bool? | +smartDeblock | +Enable auto-adjusting of the deblocking filter. + |
+
| int? | +passes | +Number of entropy-analysis passes (in [1..10]). |
in.WebpsaveMime(q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, mixed: bool, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);in.WebpsaveMime(q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, targetSize: int, mixed: bool, smartDeblock: bool, passes: int, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Save as WebP.
public void WebpsaveStream(Stream stream, int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, bool? mixed = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)public void WebpsaveStream(Stream stream, int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, int? targetSize = null, bool? mixed = null, bool? smartDeblock = null, int? passes = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| int? | effort | Level of CPU effort to reduce file size. + |
+
+
| int? | +targetSize | +Desired target size in bytes. |
| bool? | mixed | Allow mixed encoding (might reduce file size). + |
+
| bool? | +smartDeblock | +Enable auto-adjusting of the deblocking filter. + |
+
| int? | +passes | +Number of entropy-analysis passes (in [1..10]). |
in.WebpsaveStream(stream, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, mixed: bool, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);in.WebpsaveStream(stream, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, targetSize: int, mixed: bool, smartDeblock: bool, passes: int, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);Save as WebP.
public void WebpsaveTarget(Target target, int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, bool? mixed = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)public void WebpsaveTarget(Target target, int? q = null, bool? lossless = null, Enums.ForeignWebpPreset? preset = null, bool? smartSubsample = null, bool? nearLossless = null, int? alphaQ = null, bool? minSize = null, int? kmin = null, int? kmax = null, int? effort = null, int? targetSize = null, bool? mixed = null, bool? smartDeblock = null, int? passes = null, Enums.ForeignKeep? keep = null, double[] background = null, int? pageHeight = null, string profile = null)| int? | effort | Level of CPU effort to reduce file size. + |
+
+
| int? | +targetSize | +Desired target size in bytes. |
| bool? | mixed | Allow mixed encoding (might reduce file size). + |
+
| bool? | +smartDeblock | +Enable auto-adjusting of the deblocking filter. + |
+
| int? | +passes | +Number of entropy-analysis passes (in [1..10]). |
in.WebpsaveTarget(target, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, mixed: bool, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);in.WebpsaveTarget(target, q: int, lossless: bool, preset: Enums.ForeignWebpPreset, smartSubsample: bool, nearLossless: bool, alphaQ: int, minSize: bool, kmin: int, kmax: int, effort: int, targetSize: int, mixed: bool, smartDeblock: bool, passes: int, keep: Enums.ForeignKeep, background: double[], pageHeight: int, profile: string);public IntPtr WriteToMemory(out ulong size)public nint WriteToMemory(out ulong size)| IntPtr | -A IntPtr pointing to an unformatted C-style array. + | nint | +A nint pointing to an unformatted C-style array. |
The caller is responsible for freeing this memory with Free(IntPtr).
+The caller is responsible for freeing this memory with Free(nint).
| IntPtr | +nint |
| IntPtr | +nint | gtype | The GType of the metadata item to create. |
@@ -2751,10 +2778,6 @@
| bool | true if at least libvips major.minor[.patch]; otherwise, false. - |
-
Set the maximum number of operations libvips will cache.
-[Obsolete("NetVips.CacheSetMax is deprecated, please use the Cache.Max setter instead.")]
-public static void CacheSetMax(int max)| Type | -Name | -Description | -
|---|---|---|
| int | -max | -Maximum number of operations. - |
-
Limit the operation cache by number of open files.
-[Obsolete("NetVips.CacheSetMaxFiles is deprecated, please use the Cache.MaxFiles setter instead.")]
-public static void CacheSetMaxFiles(int maxFiles)| Type | -Name | -Description | -
|---|---|---|
| int | -maxFiles | -Maximum open files. - |
-
Limit the operation cache by memory use.
-[Obsolete("NetVips.CacheSetMaxMem is deprecated, please use the Cache.MaxMem setter instead.")]
-public static void CacheSetMaxMem(ulong maxMem)| Type | -Name | -Description | -
|---|---|---|
| ulong | -maxMem | -Maximum memory use. - |
-
Turn on libvips cache tracing.
-[Obsolete("NetVips.CacheSetTrace is deprecated, please use the Cache.Trace setter instead.")]
-public static void CacheSetTrace(bool trace)| Type | -Name | -Description | -
|---|---|---|
| bool | -trace | -Bool indicating if tracing should be turned on. - |
-
Returns the number of worker threads that vips uses for image evaluation.
-[Obsolete("NetVips.ConcurrencyGet is deprecated, please use the NetVips.Concurrency getter instead.")]
-public static int ConcurrencyGet()| Type | -Description | -
|---|---|
| int | -The number of worker threads. - |
-
Set the size of the pools of worker threads vips uses for image evaluation.
-[Obsolete("NetVips.ConcurrencySet is deprecated, please use the NetVips.Concurrency setter instead.")]
-public static void ConcurrencySet(int concurrency)| Type | -Name | -Description | -
|---|---|---|
| int | -concurrency | -The size of the pools of worker threads vips uses -for image evaluation. |
Frees the memory pointed to by mem.
public static void Free(IntPtr mem)public static void Free(nint mem)| IntPtr | +nint | mem | The memory to free. |
@@ -505,13 +338,13 @@
| IntPtr | +nint | type | A valid type ID. |
@@ -541,7 +374,7 @@
| IntPtr | +nint | Fundamental type ID. |
| Type | -Name | -Description | -
|---|---|---|
| bool | -leak | -Bool indicating if leak checking should be turned on. - |
-
With this enabled, libvips will check for object and area leaks on Shutdown(). -Enabling this option will make libvips run slightly more slowly.
-Returns the largest number of bytes simultaneously allocated via vips_tracked_malloc(). -Handy for estimating max memory requirements for a program.
-[Obsolete("NetVips.MemoryHigh is deprecated, please use the Stats.MemHighwater getter instead.")]
-public static ulong MemoryHigh()| Type | -Description | -
|---|---|
| ulong | -The largest number of bytes simultaneously allocated. - |
-
Returns an array with:
-vips_malloc() and friends.[Obsolete("NetVips.MemoryStats is deprecated, please use the Stats class instead.")]
-public static int[] MemoryStats()| Type | -Description | -
|---|---|
| int[] | -An array with memory stats. Handy for debugging / leak testing. - |
-
Return the nickname for a GType.
public static string NicknameFind(IntPtr type)public static string NicknameFind(nint type)| IntPtr | +nint | type | Type to return nickname for. |
@@ -791,38 +534,6 @@
Enable or disable libvips profile recording.
-[Obsolete("NetVips.ProfileSet is deprecated, please use the NetVips.Profile setter instead.")]
-public static void ProfileSet(bool profile)| Type | -Name | -Description | -
|---|---|---|
| bool | -profile | -Bool indicating if profile recording should be turned on. - |
-
If set, vips will record profiling information, and dump it on Shutdown().
-These profiles can be analyzed with the vipsprofile program.
Call this to drop caches, close plugins, terminate background threads, and finalize @@ -845,7 +556,7 @@
public static IntPtr TypeFind(string basename, string nickname)public static nint TypeFind(string basename, string nickname)| IntPtr | +nint | The GType of the class, or Zero if the class is not found. |
| IntPtr | +nint | Corresponding type ID or Zero. |
Return the name for a GType.
public static string TypeName(IntPtr type)public static string TypeName(nint type)| IntPtr | +nint | type | Type to return name for. |
@@ -978,13 +689,13 @@
Get all values for a enum (GType).
public static Dictionary<string, int> ValuesForEnum(IntPtr type)public static Dictionary<string, int> ValuesForEnum(nint type)| IntPtr | +nint | type | Type to return enum values for. |
@@ -1016,34 +727,6 @@
| Dictionary<string, int> | A list of values. - |
-
Enable or disable SIMD.
-[Obsolete("NetVips.VectorSet is deprecated, please use the NetVips.Vector setter instead.")]
-public static void VectorSet(bool enabled)| Type | -Name | -Description | -
|---|---|---|
| bool | -enabled | -Bool indicating if SIMD should be turned on. |
| Type | +Condition | +
|---|---|
| VipsException | +If unable to create a new Source from |
+
Make a new source from a memory object.
+public static Source NewFromMemory(ReadOnlySpan<byte> data)| Type | +Name | +Description | +
|---|---|---|
| ReadOnlySpan<byte> | +data | +The memory object. + |
+
| Type | +Description | +
|---|---|
| Source | +A new Source. + |
+
Make a new source that is attached to the memory object. For example:
+using var source = Source.NewFromMemory(data);You can pass this source to (for example) NewFromSource(Source, string, Access?, FailOn?, VOption).
The interface is exactly as Read(byte[], int, int). +
The interface is exactly as Read(byte[], int, int).
The handler is given a number of bytes to fetch, and should return a
bytes-like object containing up to that number of bytes. If there is
no more data available, it should return 0.
The interface is the same as Write(byte[], int, int). +
The interface is the same as Write(byte[], int, int). The handler is given a bytes-like object to write. However, the handler MUST return the number of bytes written.
public IntPtr GetTypeOf(string name)public nint GetTypeOf(string name)| IntPtr | -A new instance of IntPtr initialized to the GType or + | nint | +A new instance of nint initialized to the GType or Zero if the property does not exist. |