Class Image

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Encapsulates an image, which consists of the pixel data for a graphics image and its attributes. For the non-generic Image type, the pixel type is only known at runtime. Image is always implemented by a pixel-specific Image<TPixel> instance.

public abstract class Image : IDisposable, IConfigurationProvider

Inheritance: object

Image

Implements: IDisposable

IConfigurationProvider

Derived: Image<TPixel>

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods: AdvancedImageExtensions.AcceptVisitor(Image, IImageVisitor)

AdvancedImageExtensions.AcceptVisitorAsync(Image, IImageVisitorAsync, CancellationToken)

AdvancedImageExtensions.DetectEncoder(Image, string)

ImageExtensions.Save(Image, Stream, IImageFormat)

ImageExtensions.Save(Image, string, IImageEncoder)

ImageExtensions.Save(Image, string)

ImageExtensions.SaveAsBmp(Image, Stream, BmpEncoder)

ImageExtensions.SaveAsBmp(Image, Stream)

ImageExtensions.SaveAsBmp(Image, string, BmpEncoder)

ImageExtensions.SaveAsBmp(Image, string)

ImageExtensions.SaveAsBmpAsync(Image, Stream, BmpEncoder, CancellationToken)

ImageExtensions.SaveAsBmpAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsBmpAsync(Image, string, BmpEncoder, CancellationToken)

ImageExtensions.SaveAsBmpAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsBmpAsync(Image, string)

ImageExtensions.SaveAsGif(Image, Stream, GifEncoder)

ImageExtensions.SaveAsGif(Image, Stream)

ImageExtensions.SaveAsGif(Image, string, GifEncoder)

ImageExtensions.SaveAsGif(Image, string)

ImageExtensions.SaveAsGifAsync(Image, Stream, GifEncoder, CancellationToken)

ImageExtensions.SaveAsGifAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsGifAsync(Image, string, GifEncoder, CancellationToken)

ImageExtensions.SaveAsGifAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsGifAsync(Image, string)

ImageExtensions.SaveAsJpeg(Image, Stream, JpegEncoder)

ImageExtensions.SaveAsJpeg(Image, Stream)

ImageExtensions.SaveAsJpeg(Image, string, JpegEncoder)

ImageExtensions.SaveAsJpeg(Image, string)

ImageExtensions.SaveAsJpegAsync(Image, Stream, JpegEncoder, CancellationToken)

ImageExtensions.SaveAsJpegAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsJpegAsync(Image, string, JpegEncoder, CancellationToken)

ImageExtensions.SaveAsJpegAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsJpegAsync(Image, string)

ImageExtensions.SaveAsPbm(Image, Stream, PbmEncoder)

ImageExtensions.SaveAsPbm(Image, Stream)

ImageExtensions.SaveAsPbm(Image, string, PbmEncoder)

ImageExtensions.SaveAsPbm(Image, string)

ImageExtensions.SaveAsPbmAsync(Image, Stream, PbmEncoder, CancellationToken)

ImageExtensions.SaveAsPbmAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsPbmAsync(Image, string, PbmEncoder, CancellationToken)

ImageExtensions.SaveAsPbmAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsPbmAsync(Image, string)

ImageExtensions.SaveAsPng(Image, Stream, PngEncoder)

ImageExtensions.SaveAsPng(Image, Stream)

ImageExtensions.SaveAsPng(Image, string, PngEncoder)

ImageExtensions.SaveAsPng(Image, string)

ImageExtensions.SaveAsPngAsync(Image, Stream, PngEncoder, CancellationToken)

ImageExtensions.SaveAsPngAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsPngAsync(Image, string, PngEncoder, CancellationToken)

ImageExtensions.SaveAsPngAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsPngAsync(Image, string)

ImageExtensions.SaveAsQoi(Image, Stream, QoiEncoder)

ImageExtensions.SaveAsQoi(Image, Stream)

ImageExtensions.SaveAsQoi(Image, string, QoiEncoder)

ImageExtensions.SaveAsQoi(Image, string)

ImageExtensions.SaveAsQoiAsync(Image, Stream, QoiEncoder, CancellationToken)

ImageExtensions.SaveAsQoiAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsQoiAsync(Image, string, QoiEncoder, CancellationToken)

ImageExtensions.SaveAsQoiAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsQoiAsync(Image, string)

ImageExtensions.SaveAsTga(Image, Stream, TgaEncoder)

ImageExtensions.SaveAsTga(Image, Stream)

ImageExtensions.SaveAsTga(Image, string, TgaEncoder)

ImageExtensions.SaveAsTga(Image, string)

ImageExtensions.SaveAsTgaAsync(Image, Stream, TgaEncoder, CancellationToken)

ImageExtensions.SaveAsTgaAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsTgaAsync(Image, string, TgaEncoder, CancellationToken)

ImageExtensions.SaveAsTgaAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsTgaAsync(Image, string)

ImageExtensions.SaveAsTiff(Image, Stream, TiffEncoder)

ImageExtensions.SaveAsTiff(Image, Stream)

ImageExtensions.SaveAsTiff(Image, string, TiffEncoder)

ImageExtensions.SaveAsTiff(Image, string)

ImageExtensions.SaveAsTiffAsync(Image, Stream, TiffEncoder, CancellationToken)

ImageExtensions.SaveAsTiffAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsTiffAsync(Image, string, TiffEncoder, CancellationToken)

ImageExtensions.SaveAsTiffAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsTiffAsync(Image, string)

ImageExtensions.SaveAsWebp(Image, Stream, WebpEncoder)

ImageExtensions.SaveAsWebp(Image, Stream)

ImageExtensions.SaveAsWebp(Image, string, WebpEncoder)

ImageExtensions.SaveAsWebp(Image, string)

ImageExtensions.SaveAsWebpAsync(Image, Stream, WebpEncoder, CancellationToken)

ImageExtensions.SaveAsWebpAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsWebpAsync(Image, string, WebpEncoder, CancellationToken)

ImageExtensions.SaveAsWebpAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsWebpAsync(Image, string)

ImageExtensions.SaveAsync(Image, Stream, IImageFormat, CancellationToken)

ImageExtensions.SaveAsync(Image, string, IImageEncoder, CancellationToken)

ImageExtensions.SaveAsync(Image, string, CancellationToken)

ImageExtensions.ToBase64String(Image, IImageFormat)

ProcessingExtensions.Clone(Image, Configuration, Action<IImageProcessingContext>)

ProcessingExtensions.Clone(Image, Action<IImageProcessingContext>)

ProcessingExtensions.Mutate(Image, Configuration, Action<IImageProcessingContext>)

ProcessingExtensions.Mutate(Image, Action<IImageProcessingContext>)

Constructors

Image(Configuration, PixelTypeInfo, ImageMetadata, Size)

Initializes a new instance of the Image class.

protected Image(Configuration configuration, PixelTypeInfo pixelType, ImageMetadata metadata, Size size)

Parameters

configuration Configuration: The global configuration..
pixelType PixelTypeInfo: The pixel type information.
metadata ImageMetadata: The image metadata.
size Size: The size in px units.

Properties

Bounds

Gets the bounds of the image.

public Rectangle Bounds { get; }

Property Value

Rectangle

Configuration

public Configuration Configuration { get; }

Property Value

Configuration

Frames

Gets the frames of the image as (non-generic) ImageFrameCollection.

public ImageFrameCollection Frames { get; }

Property Value

ImageFrameCollection

Height

Gets the image height in px units.

public int Height { get; }

Property Value

int

Metadata

Gets any metadata associated with the image.

public ImageMetadata Metadata { get; }

Property Value

ImageMetadata

NonGenericFrameCollection

Gets the ImageFrameCollection implementing the public Frames property.

protected abstract ImageFrameCollection NonGenericFrameCollection { get; }

Property Value

ImageFrameCollection

PixelType

Gets information about the image pixels.

public PixelTypeInfo PixelType { get; }

Property Value

PixelTypeInfo

Size

Gets the size of the image in px units.

public Size Size { get; }

Property Value

Size

Width

Gets the image width in px units.

public int Width { get; }

Property Value

int

Methods

CloneAs<TPixel2>()

Returns a copy of the image in the given pixel format.

public Image<TPixel2> CloneAs<TPixel2>() where TPixel2 : unmanaged, IPixel<TPixel2>

Returns

Image<TPixel2>: The Image<TPixel>

Type Parameters

TPixel2: The pixel format.

CloneAs<TPixel2>(Configuration)

Returns a copy of the image in the given pixel format.

public abstract Image<TPixel2> CloneAs<TPixel2>(Configuration configuration) where TPixel2 : unmanaged, IPixel<TPixel2>

Parameters

configuration Configuration: The configuration providing initialization code which allows extending the library.

Returns

Image<TPixel2>: The Image<TPixel>.

Type Parameters

TPixel2: The pixel format.

DetectFormat(DecoderOptions, Stream)

Detects the encoded image format type from the specified stream.

public static IImageFormat DetectFormat(DecoderOptions options, Stream stream)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The image stream to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormat(DecoderOptions, ReadOnlySpan<byte>)

By reading the header on the provided byte span this calculates the images format.

public static IImageFormat DetectFormat(DecoderOptions options, ReadOnlySpan<byte> buffer)

Parameters

options DecoderOptions: The general decoder options.
buffer ReadOnlySpan<byte>: The byte span containing encoded image data to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

ArgumentNullException: The options are null.
NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormat(DecoderOptions, string)

Detects the encoded image format type from the specified file.

public static IImageFormat DetectFormat(DecoderOptions options, string path)

Parameters

options DecoderOptions: The general decoder options.
path string: The image file to open and to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormat(Stream)

Detects the encoded image format type from the specified stream.

public static IImageFormat DetectFormat(Stream stream)

Parameters

stream Stream: The image stream to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormat(ReadOnlySpan<byte>)

By reading the header on the provided byte span this calculates the images format.

public static IImageFormat DetectFormat(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>: The byte span containing encoded image data to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormat(string)

Detects the encoded image format type from the specified file.

public static IImageFormat DetectFormat(string path)

Parameters

path string: The image file to open and to read the header from.

Returns

IImageFormat: The IImageFormat.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormatAsync(DecoderOptions, Stream, CancellationToken)

Detects the encoded image format type from the specified stream.

public static Task<IImageFormat> DetectFormatAsync(DecoderOptions options, Stream stream, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The image stream to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<IImageFormat>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormatAsync(DecoderOptions, string, CancellationToken)

Detects the encoded image format type from the specified file.

public static Task<IImageFormat> DetectFormatAsync(DecoderOptions options, string path, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
path string: The image file to open and to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<IImageFormat>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormatAsync(Stream, CancellationToken)

Detects the encoded image format type from the specified stream.

public static Task<IImageFormat> DetectFormatAsync(Stream stream, CancellationToken cancellationToken = default)

Parameters

stream Stream: The image stream to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<IImageFormat>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

DetectFormatAsync(string, CancellationToken)

Detects the encoded image format type from the specified file.

public static Task<IImageFormat> DetectFormatAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string: The image file to open and to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<IImageFormat>: A Task<TResult> representing the asynchronous operation.

Dispose()

public void Dispose()

Dispose(bool)

Disposes the object and frees resources for the Garbage Collector.

protected abstract void Dispose(bool disposing)

Parameters

disposing bool: Whether to dispose of managed and unmanaged objects.

Identify(DecoderOptions, Stream)

Reads the raw image information from the specified stream without fully decoding it.

public static ImageInfo Identify(DecoderOptions options, Stream stream)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The image stream to read the information from.

Returns

ImageInfo: The ImageInfo.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Identify(DecoderOptions, ReadOnlySpan<byte>)

Reads the raw image information from the specified span of bytes without fully decoding it.

public static ImageInfo Identify(DecoderOptions options, ReadOnlySpan<byte> buffer)

Parameters

options DecoderOptions: The general decoder options.
buffer ReadOnlySpan<byte>: The byte span containing encoded image data to read the header from.

Returns

ImageInfo: The ImageInfo.

Exceptions

ArgumentNullException: The options are null.
NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Identify(DecoderOptions, string)

Reads the raw image information from the specified file path without fully decoding it.

public static ImageInfo Identify(DecoderOptions options, string path)

Parameters

options DecoderOptions: The general decoder options.
path string: The image file to open and to read the header from.

Returns

ImageInfo: The ImageInfo.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Identify(Stream)

Reads the raw image information from the specified stream without fully decoding it.

public static ImageInfo Identify(Stream stream)

Parameters

stream Stream: The image stream to read the header from.

Returns

ImageInfo: The ImageInfo.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Identify(ReadOnlySpan<byte>)

Reads the raw image information from the specified stream without fully decoding it.

public static ImageInfo Identify(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>: The byte array containing encoded image data to read the header from.

Returns

ImageInfo: The ImageInfo.

Exceptions

NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Identify(string)

Reads the raw image information from the specified file path without fully decoding it. A return value indicates whether the operation succeeded.

public static ImageInfo Identify(string path)

Parameters

path string: The image file to open and to read the header from.

Returns

ImageInfo: The ImageInfo.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

IdentifyAsync(DecoderOptions, Stream, CancellationToken)

Reads the raw image information from the specified stream without fully decoding it.

public static Task<ImageInfo> IdentifyAsync(DecoderOptions options, Stream stream, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The image stream to read the information from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<ImageInfo>: The Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

IdentifyAsync(DecoderOptions, string, CancellationToken)

Reads the raw image information from the specified stream without fully decoding it.

public static Task<ImageInfo> IdentifyAsync(DecoderOptions options, string path, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
path string: The image file to open and to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<ImageInfo>: The Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

IdentifyAsync(Stream, CancellationToken)

Reads the raw image information from the specified stream without fully decoding it.

public static Task<ImageInfo> IdentifyAsync(Stream stream, CancellationToken cancellationToken = default)

Parameters

stream Stream: The image stream to read the information from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<ImageInfo>: The Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

IdentifyAsync(string, CancellationToken)

Reads the raw image information from the specified stream without fully decoding it.

public static Task<ImageInfo> IdentifyAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string: The image file to open and to read the header from.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<ImageInfo>: The Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(DecoderOptions, Stream)

Creates a new instance of the Image class from the given stream. The pixel format is automatically determined by the decoder.

public static Image Load(DecoderOptions options, Stream stream)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The stream containing image information.

Returns

Image: Image.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(DecoderOptions, ReadOnlySpan<byte>)

Creates a new instance of the Image class from the given byte span. The pixel format is automatically determined by the decoder.

public static Image Load(DecoderOptions options, ReadOnlySpan<byte> buffer)

Parameters

options DecoderOptions: The general decoder options.
buffer ReadOnlySpan<byte>: The byte span containing encoded image data.

Returns

Image: Image.

Exceptions

ArgumentNullException: The options are null.
NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(DecoderOptions, string)

Creates a new instance of the Image class from the given file path. The pixel format is automatically determined by the decoder.

public static Image Load(DecoderOptions options, string path)

Parameters

options DecoderOptions: The general decoder options.
path string: The file path to the image.

Returns

Image: Image.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(Stream)

Creates a new instance of the Image class from the given stream. The pixel format is automatically determined by the decoder.

public static Image Load(Stream stream)

Parameters

stream Stream: The stream containing image information.

Returns

Image: Image.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(ReadOnlySpan<byte>)

Creates a new instance of the Image class from the given byte span. The pixel format is automatically determined by the decoder.

public static Image Load(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>: The byte span containing encoded image data.

Returns

Image: Image.

Exceptions

NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load(string)

Creates a new instance of the Image class from the given file path. The pixel format is automatically determined by the decoder.

public static Image Load(string path)

Parameters

path string: The file path to the image.

Returns

Image: Image.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync(DecoderOptions, Stream, CancellationToken)

Creates a new instance of the Image class from the given stream. The pixel format is automatically determined by the decoder.

public static Task<Image> LoadAsync(DecoderOptions options, Stream stream, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The stream containing image information.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync(DecoderOptions, string, CancellationToken)

Creates a new instance of the Image class from the given file path. The pixel format is automatically determined by the decoder.

public static Task<Image> LoadAsync(DecoderOptions options, string path, CancellationToken cancellationToken = default)

Parameters

options DecoderOptions: The general decoder options.
path string: The file path to the image.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync(Stream, CancellationToken)

Creates a new instance of the Image class from the given stream. The pixel format is automatically determined by the decoder.

public static Task<Image> LoadAsync(Stream stream, CancellationToken cancellationToken = default)

Parameters

stream Stream: The stream containing image information.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync(string, CancellationToken)

Creates a new instance of the Image class from the given file path. The pixel format is automatically determined by the decoder.

public static Task<Image> LoadAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string: The file path to the image.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image>: A Task<TResult> representing the asynchronous operation.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync<TPixel>(DecoderOptions, Stream, CancellationToken)

Creates a new instance of the Image<TPixel> class from the given stream.

public static Task<Image<TPixel>> LoadAsync<TPixel>(DecoderOptions options, Stream stream, CancellationToken cancellationToken = default) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The stream containing image information.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image<TPixel>>: A Task<TResult> representing the asynchronous operation.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync<TPixel>(DecoderOptions, string, CancellationToken)

Creates a new instance of the Image<TPixel> class from the given file path.

public static Task<Image<TPixel>> LoadAsync<TPixel>(DecoderOptions options, string path, CancellationToken cancellationToken = default) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options DecoderOptions: The general decoder options.
path string: The file path to the image.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image<TPixel>>: A Task<TResult> representing the asynchronous operation.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync<TPixel>(Stream, CancellationToken)

Creates a new instance of the Image<TPixel> class from the given stream.

public static Task<Image<TPixel>> LoadAsync<TPixel>(Stream stream, CancellationToken cancellationToken = default) where TPixel : unmanaged, IPixel<TPixel>

Parameters

stream Stream: The stream containing image information.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image<TPixel>>: A Task<TResult> representing the asynchronous operation.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadAsync<TPixel>(string, CancellationToken)

Creates a new instance of the Image<TPixel> class from the given file path.

public static Task<Image<TPixel>> LoadAsync<TPixel>(string path, CancellationToken cancellationToken = default) where TPixel : unmanaged, IPixel<TPixel>

Parameters

path string: The file path to the image.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task<Image<TPixel>>: A Task<TResult> representing the asynchronous operation.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

LoadPixelData<TPixel>(Configuration, ReadOnlySpan<byte>, int, int)

Create a new instance of the Image<TPixel> class from the given readonly span of bytes in TPixel format.

public static Image<TPixel> LoadPixelData<TPixel>(Configuration configuration, ReadOnlySpan<byte> data, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The configuration for the decoder.
data ReadOnlySpan<byte>: The readonly span of bytes containing image data.
width int: The width of the final image.
height int: The height of the final image.

Returns

Image<TPixel>: A new Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The configuration is null.
ArgumentException: The data length is incorrect.

LoadPixelData<TPixel>(Configuration, ReadOnlySpan<TPixel>, int, int)

Create a new instance of the Image<TPixel> class from the raw TPixel data.

public static Image<TPixel> LoadPixelData<TPixel>(Configuration configuration, ReadOnlySpan<TPixel> data, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The configuration for the decoder.
data ReadOnlySpan<TPixel>: The readonly span containing the image pixel data.
width int: The width of the final image.
height int: The height of the final image.

Returns

Image<TPixel>: A new Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The configuration is null.
ArgumentException: The data length is incorrect.

LoadPixelData<TPixel>(ReadOnlySpan<byte>, int, int)

Create a new instance of the Image<TPixel> class from the given readonly span of bytes in TPixel format.

public static Image<TPixel> LoadPixelData<TPixel>(ReadOnlySpan<byte> data, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

data ReadOnlySpan<byte>: The readonly span of bytes containing image data.
width int: The width of the final image.
height int: The height of the final image.

Returns

Image<TPixel>: A new Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentException: The data length is incorrect.

LoadPixelData<TPixel>(ReadOnlySpan<TPixel>, int, int)

Create a new instance of the Image<TPixel> class from the raw TPixel data.

public static Image<TPixel> LoadPixelData<TPixel>(ReadOnlySpan<TPixel> data, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

data ReadOnlySpan<TPixel>: The readonly span of bytes containing image data.
width int: The width of the final image.
height int: The height of the final image.

Returns

Image<TPixel>: A new Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentException: The data length is incorrect.

Load<TPixel>(DecoderOptions, Stream)

Creates a new instance of the Image<TPixel> class from the given stream.

public static Image<TPixel> Load<TPixel>(DecoderOptions options, Stream stream) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options DecoderOptions: The general decoder options.
stream Stream: The stream containing image information.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load<TPixel>(DecoderOptions, ReadOnlySpan<byte>)

Creates a new instance of the Image<TPixel> class from the given byte span.

public static Image<TPixel> Load<TPixel>(DecoderOptions options, ReadOnlySpan<byte> data) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options DecoderOptions: The general decoder options.
data ReadOnlySpan<byte>: The byte span containing encoded image data.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The options are null.
NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load<TPixel>(DecoderOptions, string)

Creates a new instance of the Image<TPixel> class from the given file path.

public static Image<TPixel> Load<TPixel>(DecoderOptions options, string path) where TPixel : unmanaged, IPixel<TPixel>

Parameters

options DecoderOptions: The general decoder options.
path string: The file path to the image.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The options are null.
ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load<TPixel>(Stream)

Creates a new instance of the Image<TPixel> class from the given stream.

public static Image<TPixel> Load<TPixel>(Stream stream) where TPixel : unmanaged, IPixel<TPixel>

Parameters

stream Stream: The stream containing image information.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The stream is null.
NotSupportedException: The stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load<TPixel>(ReadOnlySpan<byte>)

Creates a new instance of the Image<TPixel> class from the given byte span.

public static Image<TPixel> Load<TPixel>(ReadOnlySpan<byte> data) where TPixel : unmanaged, IPixel<TPixel>

Parameters

data ReadOnlySpan<byte>: The byte span containing encoded image data.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

NotSupportedException: The image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Load<TPixel>(string)

Creates a new instance of the Image<TPixel> class from the given file path.

public static Image<TPixel> Load<TPixel>(string path) where TPixel : unmanaged, IPixel<TPixel>

Parameters

path string: The file path to the image.

Returns

Image<TPixel>: Image<TPixel>.

Type Parameters

TPixel: The pixel format.

Exceptions

ArgumentNullException: The path is null.
NotSupportedException: The file stream is not readable or the image format is not supported.
InvalidImageContentException: The encoded image contains invalid content.
UnknownImageFormatException: The encoded image format is unknown.

Save(Stream, IImageEncoder)

Saves the image to the given stream using the given image encoder.

public void Save(Stream stream, IImageEncoder encoder)

Parameters

stream Stream: The stream to save the image to.
encoder IImageEncoder: The encoder to save the image with.

Exceptions

ArgumentNullException: Thrown if the stream or encoder is null.

SaveAsync(Stream, IImageEncoder, CancellationToken)

Saves the image to the given stream using the given image encoder.

public Task SaveAsync(Stream stream, IImageEncoder encoder, CancellationToken cancellationToken = default)

Parameters

stream Stream: The stream to save the image to.
encoder IImageEncoder: The encoder to save the image with.
cancellationToken CancellationToken: The token to monitor for cancellation requests.

Returns

Task: A Task representing the asynchronous operation.

Exceptions

ArgumentNullException: Thrown if the stream or encoder is null.

UpdateSize(Size)

Update the size of the image after mutation.

protected void UpdateSize(Size size)

Parameters

size Size: The Size.

WrapMemory<TPixel>(Configuration, IMemoryOwner<byte>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels, allowing to view/manipulate it as an Image<TPixel> instance. The ownership of the byteMemoryOwner is being transferred to the new Image<TPixel> instance, meaning that the caller is not allowed to dispose byteMemoryOwner. It will be disposed together with the result image.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, IMemoryOwner<byte> byteMemoryOwner, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
byteMemoryOwner IMemoryOwner<byte>: The IMemoryOwner<T> that is being transferred to the image.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type.

Exceptions

ArgumentNullException: The configuration is null.

WrapMemory<TPixel>(Configuration, IMemoryOwner<byte>, int, int, ImageMetadata)

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, IMemoryOwner<byte> byteMemoryOwner, int width, int height, ImageMetadata metadata) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
byteMemoryOwner IMemoryOwner<byte>: The IMemoryOwner<T> that is being transferred to the image
width int: The width of the memory image.
height int: The height of the memory image.
metadata ImageMetadata: The ImageMetadata

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.
ArgumentNullException: The metadata is null.

WrapMemory<TPixel>(Configuration, IMemoryOwner<TPixel>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels, allowing to view/manipulate it as an Image<TPixel> instance. The ownership of the pixelMemoryOwner is being transferred to the new Image<TPixel> instance, meaning that the caller is not allowed to dispose pixelMemoryOwner. It will be disposed together with the result image.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, IMemoryOwner<TPixel> pixelMemoryOwner, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pixelMemoryOwner IMemoryOwner<TPixel>: The IMemoryOwner<T> that is being transferred to the image.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type.

Exceptions

ArgumentNullException: The configuration is null.

WrapMemory<TPixel>(Configuration, IMemoryOwner<TPixel>, int, int, ImageMetadata)

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, IMemoryOwner<TPixel> pixelMemoryOwner, int width, int height, ImageMetadata metadata) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pixelMemoryOwner IMemoryOwner<TPixel>: The IMemoryOwner<T> that is being transferred to the image
width int: The width of the memory image.
height int: The height of the memory image.
metadata ImageMetadata: The ImageMetadata

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.
ArgumentNullException: The metadata is null.

WrapMemory<TPixel>(Configuration, Memory<byte>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

Please note: using this method does not transfer the ownership of the underlying buffer of the input Memory<T> to the new Image<TPixel> instance. This means that consumers of this method must ensure that the input buffer is either self-contained, (for example, a Memory<T> instance wrapping a new array that was created), or that the owning object is not disposed until the returned Image<TPixel> is disposed.

If the input Memory<T> instance is one retrieved from an IMemoryOwner<T> instance rented from a memory pool (such as MemoryPool<T>), and that owning instance is disposed while the image is still in use, this will lead to undefined behavior and possibly runtime crashes (as the same buffer might then be modified by other consumers while the returned image is still working on it). Make sure to control the lifetime of the input buffers appropriately.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, Memory<byte> byteMemory, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
byteMemory Memory<byte>: The byte memory representing the pixel data.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.

WrapMemory<TPixel>(Configuration, Memory<byte>, int, int, ImageMetadata)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, Memory<byte> byteMemory, int width, int height, ImageMetadata metadata) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
byteMemory Memory<byte>: The byte memory representing the pixel data.
width int: The width of the memory image.
height int: The height of the memory image.
metadata ImageMetadata: The ImageMetadata.

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.
ArgumentNullException: The metadata is null.

WrapMemory<TPixel>(Configuration, Memory<TPixel>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, Memory<TPixel> pixelMemory, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pixelMemory Memory<TPixel>: The pixel memory.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.

WrapMemory<TPixel>(Configuration, Memory<TPixel>, int, int, ImageMetadata)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, Memory<TPixel> pixelMemory, int width, int height, ImageMetadata metadata) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pixelMemory Memory<TPixel>: The pixel memory.
width int: The width of the memory image.
height int: The height of the memory image.
metadata ImageMetadata: The ImageMetadata.

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.
ArgumentNullException: The metadata is null.

WrapMemory<TPixel>(Configuration, void*, int, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

Please note: this method relies on callers to carefully manage the target memory area being referenced by the pointer and that the lifetime of such a memory area is at least equal to that of the returned Image<TPixel> instance. For example, if the input pointer references an unmanaged memory area, callers must ensure that the memory area is not freed as long as the returned Image<TPixel> is in use and not disposed. The same applies if the input memory area points to a pinned managed object, as callers must ensure that objects will remain pinned as long as the Image<TPixel> instance is in use. Failing to do so constitutes undefined behavior and will likely lead to memory corruption and runtime crashes.

Note also that if you have a Memory<T> or an array (which can be cast to Memory<T>) of either byte or TPixel values, it is highly recommended to use one of the other available overloads of this method instead (such as WrapMemory<TPixel>(Configuration, Memory<byte>, int, int) or WrapMemory<TPixel>(Configuration, Memory<TPixel>, int, int), to make the resulting code less error prone and avoid having to pin the underlying memory buffer in use. This method is primarily meant to be used when doing interop or working with buffers that are located in unmanaged memory.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, void* pointer, int bufferSizeInBytes, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pointer void*: The pointer to the target memory buffer to wrap.
bufferSizeInBytes int: The byte length of the memory allocated.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.

WrapMemory<TPixel>(Configuration, void*, int, int, int, ImageMetadata)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Configuration configuration, void* pointer, int bufferSizeInBytes, int width, int height, ImageMetadata metadata) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration: The Configuration
pointer void*: The pointer to the target memory buffer to wrap.
bufferSizeInBytes int: The byte length of the memory allocated.
width int: The width of the memory image.
height int: The height of the memory image.
metadata ImageMetadata: The ImageMetadata.

Returns

Image<TPixel>: An Image<TPixel> instance

Type Parameters

TPixel: The pixel type

Exceptions

ArgumentNullException: The configuration is null.
ArgumentNullException: The metadata is null.

WrapMemory<TPixel>(IMemoryOwner<byte>, int, int)

public static Image<TPixel> WrapMemory<TPixel>(IMemoryOwner<byte> byteMemoryOwner, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

byteMemoryOwner IMemoryOwner<byte>: The IMemoryOwner<T> that is being transferred to the image.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type

WrapMemory<TPixel>(IMemoryOwner<TPixel>, int, int)

public static Image<TPixel> WrapMemory<TPixel>(IMemoryOwner<TPixel> pixelMemoryOwner, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

pixelMemoryOwner IMemoryOwner<TPixel>: The IMemoryOwner<T> that is being transferred to the image.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type

WrapMemory<TPixel>(Memory<byte>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Memory<byte> byteMemory, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

byteMemory Memory<byte>: The byte memory representing the pixel data.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type.

WrapMemory<TPixel>(Memory<TPixel>, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(Memory<TPixel> pixelMemory, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

pixelMemory Memory<TPixel>: The pixel memory.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type.

WrapMemory<TPixel>(void*, int, int, int)

Wraps an existing contiguous memory area of at least 'width' x 'height' pixels allowing viewing/manipulation as an Image<TPixel> instance.

public static Image<TPixel> WrapMemory<TPixel>(void* pointer, int bufferSizeInBytes, int width, int height) where TPixel : unmanaged, IPixel<TPixel>

Parameters

pointer void*: The pointer to the target memory buffer to wrap.
bufferSizeInBytes int: The byte length of the memory allocated.
width int: The width of the memory image.
height int: The height of the memory image.

Returns

Image<TPixel>: An Image<TPixel> instance.

Type Parameters

TPixel: The pixel type.

Table of Contents

Class Image

Constructors

Image(Configuration, PixelTypeInfo, ImageMetadata, Size)

Parameters

Properties

Bounds

Property Value

Configuration

Property Value

Frames

Property Value

Height

Property Value

Metadata

Property Value

NonGenericFrameCollection

Property Value

PixelType

Property Value

Size

Property Value

Width

Property Value

Methods

CloneAs<TPixel2>()

Returns

Type Parameters

CloneAs<TPixel2>(Configuration)

Parameters

Returns

Type Parameters

DetectFormat(DecoderOptions, Stream)

Parameters

Returns

Exceptions

DetectFormat(DecoderOptions, ReadOnlySpan<byte>)

Parameters

Returns

Exceptions

DetectFormat(DecoderOptions, string)

Parameters

Returns

Exceptions

DetectFormat(Stream)

Parameters

Returns

Exceptions

DetectFormat(ReadOnlySpan<byte>)

Parameters

Returns

Exceptions

DetectFormat(string)

Parameters

Returns

Exceptions

DetectFormatAsync(DecoderOptions, Stream, CancellationToken)

Parameters

Returns

Exceptions

DetectFormatAsync(DecoderOptions, string, CancellationToken)

Parameters

Returns

Exceptions

DetectFormatAsync(Stream, CancellationToken)

Parameters

Returns

Exceptions

DetectFormatAsync(string, CancellationToken)

Parameters

Returns

Dispose()

Dispose(bool)

Parameters

Identify(DecoderOptions, Stream)

Parameters

Returns

Exceptions

Identify(DecoderOptions, ReadOnlySpan<byte>)

Parameters