Class Image<TPixel>

Encapsulates an image, which consists of the pixel data for a graphics image and its attributes. For generic Image<TPixel>-s the pixel type is known at compile time.

Inheritance

object

Image

Image<TPixel>

Implements

IDisposable

IConfigurationProvider

Inherited Members

Image.Configuration

Image.PixelType

Image.Width

Image.Height

Image.Metadata

Image.Size

Image.Bounds

Image.Dispose()

Image.Save(Stream, IImageEncoder)

Image.SaveAsync(Stream, IImageEncoder, CancellationToken)

Image.CloneAs<TPixel2>()

Image.DetectFormat(ReadOnlySpan<byte>)

Image.DetectFormat(DecoderOptions, ReadOnlySpan<byte>)

Image.Identify(ReadOnlySpan<byte>)

Image.Identify(DecoderOptions, ReadOnlySpan<byte>)

Image.Load(ReadOnlySpan<byte>)

Image.Load(DecoderOptions, ReadOnlySpan<byte>)

Image.Load<TPixel>(ReadOnlySpan<byte>)

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

Image.DetectFormat(string)

Image.DetectFormat(DecoderOptions, string)

Image.DetectFormatAsync(string, CancellationToken)

Image.DetectFormatAsync(DecoderOptions, string, CancellationToken)

Image.Identify(string)

Image.Identify(DecoderOptions, string)

Image.IdentifyAsync(string, CancellationToken)

Image.IdentifyAsync(DecoderOptions, string, CancellationToken)

Image.Load(string)

Image.Load(DecoderOptions, string)

Image.LoadAsync(string, CancellationToken)

Image.LoadAsync(DecoderOptions, string, CancellationToken)

Image.Load<TPixel>(string)

Image.Load<TPixel>(DecoderOptions, string)

Image.LoadAsync<TPixel>(string, CancellationToken)

Image.LoadAsync<TPixel>(DecoderOptions, string, CancellationToken)

Image.DetectFormat(Stream)

Image.DetectFormat(DecoderOptions, Stream)

Image.DetectFormatAsync(Stream, CancellationToken)

Image.DetectFormatAsync(DecoderOptions, Stream, CancellationToken)

Image.Identify(Stream)

Image.Identify(DecoderOptions, Stream)

Image.IdentifyAsync(Stream, CancellationToken)

Image.IdentifyAsync(DecoderOptions, Stream, CancellationToken)

Image.Load(Stream)

Image.Load(DecoderOptions, Stream)

Image.LoadAsync(Stream, CancellationToken)

Image.LoadAsync(DecoderOptions, Stream, CancellationToken)

Image.Load<TPixel>(Stream)

Image.Load<TPixel>(DecoderOptions, Stream)

Image.LoadAsync<TPixel>(Stream, CancellationToken)

Image.LoadAsync<TPixel>(DecoderOptions, Stream, CancellationToken)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class Image<TPixel> : Image, IDisposable, IConfigurationProvider where TPixel : unmanaged, IPixel<TPixel>

Type Parameters

Name	Description
TPixel	The pixel format.

Constructors

Image(Configuration, int, int)

Initializes a new instance of the Image<TPixel> class with the height and the width of the image.

Declaration

public Image(Configuration configuration, int width, int height)

Parameters

Type	Name	Description
Configuration	configuration	The configuration providing initialization code which allows extending the library.
int	width	The width of the image in pixels.
int	height	The height of the image in pixels.

Image(Configuration, int, int, TPixel)

Initializes a new instance of the Image<TPixel> class with the height and the width of the image.

Declaration

public Image(Configuration configuration, int width, int height, TPixel backgroundColor)

Parameters

Type	Name	Description
Configuration	configuration	The configuration providing initialization code which allows extending the library.
int	width	The width of the image in pixels.
int	height	The height of the image in pixels.
TPixel	backgroundColor	The color to initialize the pixels with.

Image(int, int)

Initializes a new instance of the Image<TPixel> class with the height and the width of the image.

Declaration

public Image(int width, int height)

Parameters

Type	Name	Description
int	width	The width of the image in pixels.
int	height	The height of the image in pixels.

Image(int, int, TPixel)

Initializes a new instance of the Image<TPixel> class with the height and the width of the image.

Declaration

public Image(int width, int height, TPixel backgroundColor)

Parameters

Type	Name	Description
int	width	The width of the image in pixels.
int	height	The height of the image in pixels.
TPixel	backgroundColor	The color to initialize the pixels with.

Properties

Frames

Gets the collection of image frames.

Declaration

public ImageFrameCollection<TPixel> Frames { get; }

Property Value

Type	Description
ImageFrameCollection<TPixel>

this[int, int]

Gets or sets the pixel at the specified position.

Declaration

public TPixel this[int x, int y] { get; set; }

Parameters

Type	Name	Description
int	x	The x-coordinate of the pixel. Must be greater than or equal to zero and less than the width of the image.
int	y	The y-coordinate of the pixel. Must be greater than or equal to zero and less than the height of the image.

Property Value

Type	Description
TPixel	The at the specified position.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when the provided (x,y) coordinates are outside the image boundary.

NonGenericFrameCollection

Gets the ImageFrameCollection implementing the public Frames property.

Declaration

protected override ImageFrameCollection NonGenericFrameCollection { get; }

Property Value

Type	Description
ImageFrameCollection

Overrides

Image.NonGenericFrameCollection

Methods

Clone()

Clones the current image

Declaration

public Image<TPixel> Clone()

Returns

Type	Description
Image<TPixel>	Returns a new image with all the same metadata as the original.

Clone(Configuration)

Clones the current image with the given configuration.

Declaration

public Image<TPixel> Clone(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	The configuration providing initialization code which allows extending the library.

Returns

Type	Description
Image<TPixel>	Returns a new Image<TPixel> with all the same pixel data as the original.

CloneAs<TPixel2>(Configuration)

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

Declaration

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

Parameters

Type	Name	Description
Configuration	configuration	The configuration providing initialization code which allows extending the library.

Returns

Type	Description
Image<TPixel2>	The Image<TPixel>.

Type Parameters

Name	Description
TPixel2	The pixel format.

Overrides

Image.CloneAs<TPixel2>(Configuration)

CopyPixelDataTo(Span<byte>)

Copy image pixels to destination.

Declaration

public void CopyPixelDataTo(Span<byte> destination)

Parameters

Type	Name	Description
Span<byte>	destination	The Span<T> of byte to copy image pixels to.

CopyPixelDataTo(Span<TPixel>)

Copy image pixels to destination.

Declaration

public void CopyPixelDataTo(Span<TPixel> destination)

Parameters

Type	Name	Description
Span<TPixel>	destination	The Span<T> to copy image pixels to.

DangerousTryGetSinglePixelMemory(out Memory<TPixel>)

Gets the representation of the pixels as a Memory<T> in the source image's pixel format stored in row major order, if the backing buffer is contiguous.

To ensure the memory is contiguous, PreferContiguousImageBuffers should be set to true, preferably on a non-global configuration instance (not Default).

WARNING: Disposing or leaking the underlying image while still working with the memory's Span<T> might lead to memory corruption.

Declaration

public bool DangerousTryGetSinglePixelMemory(out Memory<TPixel> memory)

Parameters

Type	Name	Description
Memory<TPixel>	memory	The Memory<T> referencing the image buffer.

Returns

Type	Description
bool	The bool indicating the success.

Dispose(bool)

Disposes the object and frees resources for the Garbage Collector.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Whether to dispose of managed and unmanaged objects.

Overrides

Image.Dispose(bool)

ProcessPixelRows(PixelAccessorAction<TPixel>)

Execute processPixels to process image pixels in a safe and efficient manner.

Declaration

public void ProcessPixelRows(PixelAccessorAction<TPixel> processPixels)

Parameters

Type	Name	Description
PixelAccessorAction<TPixel>	processPixels	The PixelAccessorAction<TPixel> defining the pixel operations.

ProcessPixelRows<TPixel2>(Image<TPixel2>, PixelAccessorAction<TPixel, TPixel2>)

Execute processPixels to process pixels of multiple images in a safe and efficient manner.

Declaration

public void ProcessPixelRows<TPixel2>(Image<TPixel2> image2, PixelAccessorAction<TPixel, TPixel2> processPixels) where TPixel2 : unmanaged, IPixel<TPixel2>

Parameters

Type	Name	Description
Image<TPixel2>	image2	The second image.
PixelAccessorAction<TPixel, TPixel2>	processPixels	The PixelAccessorAction<TPixel1, TPixel2> defining the pixel operations.

Type Parameters

Name	Description
TPixel2	The pixel type of the second image.

ProcessPixelRows<TPixel2, TPixel3>(Image<TPixel2>, Image<TPixel3>, PixelAccessorAction<TPixel, TPixel2, TPixel3>)

Execute processPixels to process pixels of multiple images in a safe and efficient manner.

Declaration

public void ProcessPixelRows<TPixel2, TPixel3>(Image<TPixel2> image2, Image<TPixel3> image3, PixelAccessorAction<TPixel, TPixel2, TPixel3> processPixels) where TPixel2 : unmanaged, IPixel<TPixel2> where TPixel3 : unmanaged, IPixel<TPixel3>

Parameters

Type	Name	Description
Image<TPixel2>	image2	The second image.
Image<TPixel3>	image3	The third image.
PixelAccessorAction<TPixel, TPixel2, TPixel3>	processPixels	The PixelAccessorAction<TPixel1, TPixel2, TPixel3> defining the pixel operations.

Type Parameters

Name	Description
TPixel2	The pixel type of the second image.
TPixel3	The pixel type of the third image.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

Implements

IDisposable

IConfigurationProvider

Extension Methods

AdvancedImageExtensions.AcceptVisitor(Image, IImageVisitor)

AdvancedImageExtensions.AcceptVisitorAsync(Image, IImageVisitorAsync, CancellationToken)

AdvancedImageExtensions.DetectEncoder(Image, string)

ImageExtensions.Save(Image, Stream, IImageFormat)

ImageExtensions.Save(Image, string)

ImageExtensions.Save(Image, string, IImageEncoder)

ImageExtensions.SaveAsBmp(Image, Stream)

ImageExtensions.SaveAsBmp(Image, Stream, BmpEncoder)

ImageExtensions.SaveAsBmp(Image, string)

ImageExtensions.SaveAsBmp(Image, string, BmpEncoder)

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

ImageExtensions.SaveAsBmpAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsBmpAsync(Image, string)

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

ImageExtensions.SaveAsBmpAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsGif(Image, Stream)

ImageExtensions.SaveAsGif(Image, Stream, GifEncoder)

ImageExtensions.SaveAsGif(Image, string)

ImageExtensions.SaveAsGif(Image, string, GifEncoder)

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

ImageExtensions.SaveAsGifAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsGifAsync(Image, string)

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

ImageExtensions.SaveAsGifAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsJpeg(Image, Stream)

ImageExtensions.SaveAsJpeg(Image, Stream, JpegEncoder)

ImageExtensions.SaveAsJpeg(Image, string)

ImageExtensions.SaveAsJpeg(Image, string, JpegEncoder)

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

ImageExtensions.SaveAsJpegAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsJpegAsync(Image, string)

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

ImageExtensions.SaveAsJpegAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsPbm(Image, Stream)

ImageExtensions.SaveAsPbm(Image, Stream, PbmEncoder)

ImageExtensions.SaveAsPbm(Image, string)

ImageExtensions.SaveAsPbm(Image, string, PbmEncoder)

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

ImageExtensions.SaveAsPbmAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsPbmAsync(Image, string)

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

ImageExtensions.SaveAsPbmAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsPng(Image, Stream)

ImageExtensions.SaveAsPng(Image, Stream, PngEncoder)

ImageExtensions.SaveAsPng(Image, string)

ImageExtensions.SaveAsPng(Image, string, PngEncoder)

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

ImageExtensions.SaveAsPngAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsPngAsync(Image, string)

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

ImageExtensions.SaveAsPngAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsQoi(Image, Stream)

ImageExtensions.SaveAsQoi(Image, Stream, QoiEncoder)

ImageExtensions.SaveAsQoi(Image, string)

ImageExtensions.SaveAsQoi(Image, string, QoiEncoder)

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

ImageExtensions.SaveAsQoiAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsQoiAsync(Image, string)

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

ImageExtensions.SaveAsQoiAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsTga(Image, Stream)

ImageExtensions.SaveAsTga(Image, Stream, TgaEncoder)

ImageExtensions.SaveAsTga(Image, string)

ImageExtensions.SaveAsTga(Image, string, TgaEncoder)

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

ImageExtensions.SaveAsTgaAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsTgaAsync(Image, string)

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

ImageExtensions.SaveAsTgaAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsTiff(Image, Stream)

ImageExtensions.SaveAsTiff(Image, Stream, TiffEncoder)

ImageExtensions.SaveAsTiff(Image, string)

ImageExtensions.SaveAsTiff(Image, string, TiffEncoder)

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

ImageExtensions.SaveAsTiffAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsTiffAsync(Image, string)

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

ImageExtensions.SaveAsTiffAsync(Image, string, CancellationToken)

ImageExtensions.SaveAsWebp(Image, Stream)

ImageExtensions.SaveAsWebp(Image, Stream, WebpEncoder)

ImageExtensions.SaveAsWebp(Image, string)

ImageExtensions.SaveAsWebp(Image, string, WebpEncoder)

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

ImageExtensions.SaveAsWebpAsync(Image, Stream, CancellationToken)

ImageExtensions.SaveAsWebpAsync(Image, string)

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

ImageExtensions.SaveAsWebpAsync(Image, string, CancellationToken)

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>)

AdvancedImageExtensions.DangerousGetPixelRowMemory<TPixel>(Image<TPixel>, int)

AdvancedImageExtensions.GetPixelMemoryGroup<TPixel>(Image<TPixel>)

ProcessingExtensions.CalculateIntegralImage<TPixel>(Image<TPixel>)

ProcessingExtensions.CalculateIntegralImage<TPixel>(Image<TPixel>, Rectangle)

ProcessingExtensions.Clone<TPixel>(Image<TPixel>, Configuration, params IImageProcessor[])

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

ProcessingExtensions.Clone<TPixel>(Image<TPixel>, params IImageProcessor[])

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

ProcessingExtensions.Mutate<TPixel>(Image<TPixel>, Configuration, params IImageProcessor[])

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

ProcessingExtensions.Mutate<TPixel>(Image<TPixel>, params IImageProcessor[])

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