Class MetadataExtensions

Extension methods for the ImageMetadata type.

Inheritance

object

MetadataExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Syntax

public static class MetadataExtensions

Methods

GetBmpMetadata(ImageMetadata)

Gets the bmp format specific metadata for the image.

Declaration

public static BmpMetadata GetBmpMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
BmpMetadata	The BmpMetadata.

GetGifMetadata(ImageFrameMetadata)

Gets the gif format specific metadata for the image frame.

Declaration

public static GifFrameMetadata GetGifMetadata(this ImageFrameMetadata source)

Parameters

Type	Name	Description
ImageFrameMetadata	source	The metadata this method extends.

Returns

Type	Description
GifFrameMetadata	The GifFrameMetadata.

GetGifMetadata(ImageMetadata)

Gets the gif format specific metadata for the image.

Declaration

public static GifMetadata GetGifMetadata(this ImageMetadata source)

Parameters

Type	Name	Description
ImageMetadata	source	The metadata this method extends.

Returns

Type	Description
GifMetadata	The GifMetadata.

GetJpegMetadata(ImageMetadata)

Gets the jpeg format specific metadata for the image.

Declaration

public static JpegMetadata GetJpegMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
JpegMetadata	The JpegMetadata.

GetPbmMetadata(ImageMetadata)

Gets the pbm format specific metadata for the image.

Declaration

public static PbmMetadata GetPbmMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
PbmMetadata	The PbmMetadata.

GetPngMetadata(ImageFrameMetadata)

Gets the png format specific metadata for the image frame.

Declaration

public static PngFrameMetadata GetPngMetadata(this ImageFrameMetadata source)

Parameters

Type	Name	Description
ImageFrameMetadata	source	The metadata this method extends.

Returns

Type	Description
PngFrameMetadata	The PngFrameMetadata.

GetPngMetadata(ImageMetadata)

Gets the png format specific metadata for the image.

Declaration

public static PngMetadata GetPngMetadata(this ImageMetadata source)

Parameters

Type	Name	Description
ImageMetadata	source	The metadata this method extends.

Returns

Type	Description
PngMetadata	The PngMetadata.

GetQoiMetadata(ImageMetadata)

Gets the qoi format specific metadata for the image.

Declaration

public static QoiMetadata GetQoiMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
QoiMetadata	The QoiMetadata.

GetTgaMetadata(ImageMetadata)

Gets the tga format specific metadata for the image.

Declaration

public static TgaMetadata GetTgaMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
TgaMetadata	The TgaMetadata.

GetTiffMetadata(ImageFrameMetadata)

Gets the tiff format specific metadata for the image frame.

Declaration

public static TiffFrameMetadata GetTiffMetadata(this ImageFrameMetadata metadata)

Parameters

Type	Name	Description
ImageFrameMetadata	metadata	The metadata this method extends.

Returns

Type	Description
TiffFrameMetadata	The TiffFrameMetadata.

GetTiffMetadata(ImageMetadata)

Gets the tiff format specific metadata for the image.

Declaration

public static TiffMetadata GetTiffMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
TiffMetadata	The TiffMetadata.

GetWebpMetadata(ImageFrameMetadata)

Gets the webp format specific metadata for the image frame.

Declaration

public static WebpFrameMetadata GetWebpMetadata(this ImageFrameMetadata metadata)

Parameters

Type	Name	Description
ImageFrameMetadata	metadata	The metadata this method extends.

Returns

Type	Description
WebpFrameMetadata	The WebpFrameMetadata.

GetWebpMetadata(ImageMetadata)

Gets the webp format specific metadata for the image.

Declaration

public static WebpMetadata GetWebpMetadata(this ImageMetadata metadata)

Parameters

Type	Name	Description
ImageMetadata	metadata	The metadata this method extends.

Returns

Type	Description
WebpMetadata	The WebpMetadata.

TryGetGifMetadata(ImageFrameMetadata, out GifFrameMetadata?)

Gets the gif format specific metadata for the image frame.

Declaration

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

Parameters

Type	Name	Description
ImageFrameMetadata	source	The metadata this method extends.
GifFrameMetadata	metadata	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

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

TryGetGifMetadata(ImageMetadata, out GifMetadata?)

Gets the gif format specific metadata for the image.

Declaration

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

Parameters

Type	Name	Description
ImageMetadata	source	The metadata this method extends.
GifMetadata	metadata	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

Type	Description
bool	true if the gif metadata exists; otherwise, false.

TryGetPngMetadata(ImageFrameMetadata, out PngFrameMetadata?)

Gets the png format specific metadata for the image frame.

Declaration

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

Parameters

Type	Name	Description
ImageFrameMetadata	source	The metadata this method extends.
PngFrameMetadata	metadata	The metadata.

Returns

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

TryGetPngMetadata(ImageMetadata, out PngMetadata?)

Gets the png format specific metadata for the image.

Declaration

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

Parameters

Type	Name	Description
ImageMetadata	source	The metadata this method extends.
PngMetadata	metadata	The metadata.

Returns

Type	Description
bool	true if the png metadata exists; otherwise, false.

TryGetWebpFrameMetadata(ImageFrameMetadata, out WebpFrameMetadata?)

Gets the webp format specific metadata for the image frame.

Declaration

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

Parameters

Type	Name	Description
ImageFrameMetadata	source	The metadata this method extends.
WebpFrameMetadata	metadata	The metadata.

Returns

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

TryGetWebpMetadata(ImageMetadata, out WebpMetadata?)

Gets the webp format specific metadata for the image.

Declaration

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

Parameters

Type	Name	Description
ImageMetadata	source	The metadata this method extends.
WebpMetadata	metadata	The metadata.

Returns

Type	Description
bool	true if the webp metadata exists; otherwise, false.