Table of Contents

Class ImageMetadataExtensions

Namespace
SixLabors.ImageSharp
Assembly
SixLabors.ImageSharp.dll

Extension methods for the ImageMetadata and ImageFrameMetadata types.

public static class ImageMetadataExtensions
Inheritance
ImageMetadataExtensions
Inherited Members

Methods

CloneBmpMetadata(ImageMetadata)

Creates a new cloned instance of BmpMetadata from the source. The instance is created via GetBmpMetadata(ImageMetadata)

public static BmpMetadata CloneBmpMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

BmpMetadata

The new BmpMetadata

CloneCurMetadata(ImageFrameMetadata)

Creates a new cloned instance of CurMetadata from the source. The instance is created via GetCurMetadata(ImageFrameMetadata)

public static CurFrameMetadata CloneCurMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

CurFrameMetadata

The new CurFrameMetadata

CloneCurMetadata(ImageMetadata)

Creates a new cloned instance of CurMetadata from the source. The instance is created via GetCurMetadata(ImageMetadata)

public static CurMetadata CloneCurMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

CurMetadata

The new CurMetadata

CloneExrMetadata(ImageMetadata)

Creates a new cloned instance of ExrMetadata from the source. The instance is created via GetExrMetadata(ImageMetadata)

public static ExrMetadata CloneExrMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

ExrMetadata

The new ExrMetadata

CloneGifMetadata(ImageFrameMetadata)

Creates a new cloned instance of GifMetadata from the source. The instance is created via GetGifMetadata(ImageFrameMetadata)

public static GifFrameMetadata CloneGifMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

GifFrameMetadata

The new GifFrameMetadata

CloneGifMetadata(ImageMetadata)

Creates a new cloned instance of GifMetadata from the source. The instance is created via GetGifMetadata(ImageMetadata)

public static GifMetadata CloneGifMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

GifMetadata

The new GifMetadata

CloneIcoMetadata(ImageFrameMetadata)

Creates a new cloned instance of IcoMetadata from the source. The instance is created via GetIcoMetadata(ImageFrameMetadata)

public static IcoFrameMetadata CloneIcoMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

IcoFrameMetadata

The new IcoFrameMetadata

CloneIcoMetadata(ImageMetadata)

Creates a new cloned instance of IcoMetadata from the source. The instance is created via GetIcoMetadata(ImageMetadata)

public static IcoMetadata CloneIcoMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

IcoMetadata

The new IcoMetadata

CloneJpegMetadata(ImageMetadata)

Creates a new cloned instance of JpegMetadata from the source. The instance is created via GetJpegMetadata(ImageMetadata)

public static JpegMetadata CloneJpegMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

JpegMetadata

The new JpegMetadata

ClonePbmMetadata(ImageMetadata)

Creates a new cloned instance of PbmMetadata from the source. The instance is created via GetPbmMetadata(ImageMetadata)

public static PbmMetadata ClonePbmMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

PbmMetadata

The new PbmMetadata

ClonePngMetadata(ImageFrameMetadata)

Creates a new cloned instance of PngMetadata from the source. The instance is created via GetPngMetadata(ImageFrameMetadata)

public static PngFrameMetadata ClonePngMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

PngFrameMetadata

The new PngFrameMetadata

ClonePngMetadata(ImageMetadata)

Creates a new cloned instance of PngMetadata from the source. The instance is created via GetPngMetadata(ImageMetadata)

public static PngMetadata ClonePngMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

PngMetadata

The new PngMetadata

CloneQoiMetadata(ImageMetadata)

Creates a new cloned instance of QoiMetadata from the source. The instance is created via GetQoiMetadata(ImageMetadata)

public static QoiMetadata CloneQoiMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

QoiMetadata

The new QoiMetadata

CloneTgaMetadata(ImageMetadata)

Creates a new cloned instance of TgaMetadata from the source. The instance is created via GetTgaMetadata(ImageMetadata)

public static TgaMetadata CloneTgaMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

TgaMetadata

The new TgaMetadata

CloneTiffMetadata(ImageFrameMetadata)

Creates a new cloned instance of TiffMetadata from the source. The instance is created via GetTiffMetadata(ImageFrameMetadata)

public static TiffFrameMetadata CloneTiffMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

TiffFrameMetadata

The new TiffFrameMetadata

CloneTiffMetadata(ImageMetadata)

Creates a new cloned instance of TiffMetadata from the source. The instance is created via GetTiffMetadata(ImageMetadata)

public static TiffMetadata CloneTiffMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

TiffMetadata

The new TiffMetadata

CloneWebpMetadata(ImageFrameMetadata)

Creates a new cloned instance of WebpMetadata from the source. The instance is created via GetWebpMetadata(ImageFrameMetadata)

public static WebpFrameMetadata CloneWebpMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

WebpFrameMetadata

The new WebpFrameMetadata

CloneWebpMetadata(ImageMetadata)

Creates a new cloned instance of WebpMetadata from the source. The instance is created via GetWebpMetadata(ImageMetadata)

public static WebpMetadata CloneWebpMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

WebpMetadata

The new WebpMetadata

GetBmpMetadata(ImageMetadata)

Gets the BmpMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static BmpMetadata GetBmpMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

BmpMetadata

The BmpMetadata

GetCurMetadata(ImageFrameMetadata)

Gets the CurFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static CurFrameMetadata GetCurMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

CurFrameMetadata

The CurFrameMetadata

GetCurMetadata(ImageMetadata)

Gets the CurMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static CurMetadata GetCurMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

CurMetadata

The CurMetadata

GetExrMetadata(ImageMetadata)

Gets the ExrMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static ExrMetadata GetExrMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

ExrMetadata

The ExrMetadata

GetGifMetadata(ImageFrameMetadata)

Gets the GifFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static GifFrameMetadata GetGifMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

GifFrameMetadata

The GifFrameMetadata

GetGifMetadata(ImageMetadata)

Gets the GifMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static GifMetadata GetGifMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

GifMetadata

The GifMetadata

GetIcoMetadata(ImageFrameMetadata)

Gets the IcoFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static IcoFrameMetadata GetIcoMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

IcoFrameMetadata

The IcoFrameMetadata

GetIcoMetadata(ImageMetadata)

Gets the IcoMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static IcoMetadata GetIcoMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

IcoMetadata

The IcoMetadata

GetJpegMetadata(ImageMetadata)

Gets the JpegMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static JpegMetadata GetJpegMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

JpegMetadata

The JpegMetadata

GetPbmMetadata(ImageMetadata)

Gets the PbmMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static PbmMetadata GetPbmMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

PbmMetadata

The PbmMetadata

GetPngMetadata(ImageFrameMetadata)

Gets the PngFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static PngFrameMetadata GetPngMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

PngFrameMetadata

The PngFrameMetadata

GetPngMetadata(ImageMetadata)

Gets the PngMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static PngMetadata GetPngMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

PngMetadata

The PngMetadata

GetQoiMetadata(ImageMetadata)

Gets the QoiMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static QoiMetadata GetQoiMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

QoiMetadata

The QoiMetadata

GetTgaMetadata(ImageMetadata)

Gets the TgaMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static TgaMetadata GetTgaMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

TgaMetadata

The TgaMetadata

GetTiffMetadata(ImageFrameMetadata)

Gets the TiffFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static TiffFrameMetadata GetTiffMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

TiffFrameMetadata

The TiffFrameMetadata

GetTiffMetadata(ImageMetadata)

Gets the TiffMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static TiffMetadata GetTiffMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

TiffMetadata

The TiffMetadata

GetWebpMetadata(ImageFrameMetadata)

Gets the WebpFrameMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static WebpFrameMetadata GetWebpMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The image frame metadata.

Returns

WebpFrameMetadata

The WebpFrameMetadata

GetWebpMetadata(ImageMetadata)

Gets the WebpMetadata from source.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

public static WebpMetadata GetWebpMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The image metadata.

Returns

WebpMetadata

The WebpMetadata