Class MetadataExtensions

Namespace

SixLabors.ImageSharp

Assembly

SixLabors.ImageSharp.dll

Extension methods for the ImageMetadata type.

public static class MetadataExtensions

Inheritance

object

MetadataExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetBmpMetadata(ImageMetadata)

Gets the bmp format specific metadata for the image.

public static BmpMetadata GetBmpMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

BmpMetadata

The BmpMetadata.

GetGifMetadata(ImageFrameMetadata)

Gets the gif format specific metadata for the image frame.

public static GifFrameMetadata GetGifMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The metadata this method extends.

Returns

GifFrameMetadata

The GifFrameMetadata.

GetGifMetadata(ImageMetadata)

Gets the gif format specific metadata for the image.

public static GifMetadata GetGifMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The metadata this method extends.

Returns

GifMetadata

The GifMetadata.

GetJpegMetadata(ImageMetadata)

Gets the jpeg format specific metadata for the image.

public static JpegMetadata GetJpegMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

JpegMetadata

The JpegMetadata.

GetPbmMetadata(ImageMetadata)

Gets the pbm format specific metadata for the image.

public static PbmMetadata GetPbmMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

PbmMetadata

The PbmMetadata.

GetPngMetadata(ImageFrameMetadata)

Gets the png format specific metadata for the image frame.

public static PngFrameMetadata GetPngMetadata(this ImageFrameMetadata source)

Parameters

source ImageFrameMetadata

The metadata this method extends.

Returns

PngFrameMetadata

The PngFrameMetadata.

GetPngMetadata(ImageMetadata)

Gets the png format specific metadata for the image.

public static PngMetadata GetPngMetadata(this ImageMetadata source)

Parameters

source ImageMetadata

The metadata this method extends.

Returns

PngMetadata

The PngMetadata.

GetQoiMetadata(ImageMetadata)

Gets the qoi format specific metadata for the image.

public static QoiMetadata GetQoiMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

QoiMetadata

The QoiMetadata.

GetTgaMetadata(ImageMetadata)

Gets the tga format specific metadata for the image.

public static TgaMetadata GetTgaMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

TgaMetadata

The TgaMetadata.

GetTiffMetadata(ImageFrameMetadata)

Gets the tiff format specific metadata for the image frame.

public static TiffFrameMetadata GetTiffMetadata(this ImageFrameMetadata metadata)

Parameters

metadata ImageFrameMetadata

The metadata this method extends.

Returns

TiffFrameMetadata

The TiffFrameMetadata.

GetTiffMetadata(ImageMetadata)

Gets the tiff format specific metadata for the image.

public static TiffMetadata GetTiffMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

TiffMetadata

The TiffMetadata.

GetWebpMetadata(ImageFrameMetadata)

Gets the webp format specific metadata for the image frame.

public static WebpFrameMetadata GetWebpMetadata(this ImageFrameMetadata metadata)

Parameters

metadata ImageFrameMetadata

The metadata this method extends.

Returns

WebpFrameMetadata

The WebpFrameMetadata.

GetWebpMetadata(ImageMetadata)

Gets the webp format specific metadata for the image.

public static WebpMetadata GetWebpMetadata(this ImageMetadata metadata)

Parameters

metadata ImageMetadata

The metadata this method extends.

Returns

WebpMetadata

The WebpMetadata.

TryGetGifMetadata(ImageFrameMetadata, out GifFrameMetadata?)

Gets the gif format specific metadata for the image frame.

public static bool TryGetGifMetadata(this ImageFrameMetadata source, out GifFrameMetadata? metadata)

Parameters

source ImageFrameMetadata

The metadata this method extends.

metadata GifFrameMetadata

When this method returns, contains the metadata associated with the specified frame, if found; otherwise, the default value for the type of the metadata parameter. This parameter is passed uninitialized.

Returns

bool

true if the gif frame metadata exists; otherwise, false.

TryGetGifMetadata(ImageMetadata, out GifMetadata?)

Gets the gif format specific metadata for the image.

public static bool TryGetGifMetadata(this ImageMetadata source, out GifMetadata? metadata)

Parameters

source ImageMetadata

The metadata this method extends.

metadata GifMetadata

When this method returns, contains the metadata associated with the specified image, if found; otherwise, the default value for the type of the metadata parameter. This parameter is passed uninitialized.

Returns

bool

true if the gif metadata exists; otherwise, false.

TryGetPngMetadata(ImageFrameMetadata, out PngFrameMetadata?)

Gets the png format specific metadata for the image frame.

public static bool TryGetPngMetadata(this ImageFrameMetadata source, out PngFrameMetadata? metadata)

Parameters

source ImageFrameMetadata

The metadata this method extends.

metadata PngFrameMetadata

The metadata.

Returns

bool

true if the png frame metadata exists; otherwise, false.

TryGetPngMetadata(ImageMetadata, out PngMetadata?)

Gets the png format specific metadata for the image.

public static bool TryGetPngMetadata(this ImageMetadata source, out PngMetadata? metadata)

Parameters

source ImageMetadata

The metadata this method extends.

metadata PngMetadata

The metadata.

Returns

bool

true if the png metadata exists; otherwise, false.

TryGetWebpFrameMetadata(ImageFrameMetadata, out WebpFrameMetadata?)

Gets the webp format specific metadata for the image frame.

public static bool TryGetWebpFrameMetadata(this ImageFrameMetadata source, out WebpFrameMetadata? metadata)

Parameters

source ImageFrameMetadata

The metadata this method extends.

metadata WebpFrameMetadata

The metadata.

Returns

bool

true if the webp frame metadata exists; otherwise, false.

TryGetWebpMetadata(ImageMetadata, out WebpMetadata?)

Gets the webp format specific metadata for the image.

public static bool TryGetWebpMetadata(this ImageMetadata source, out WebpMetadata? metadata)

Parameters

source ImageMetadata

The metadata this method extends.

metadata WebpMetadata

The metadata.

Returns

bool

true if the webp metadata exists; otherwise, false.