Class MetadataExtensions

Extension methods for the ImageMetadata type.

Inheritance
Object
MetadataExtensions
Namespace: SixLabors.ImageSharp
Assembly: SixLabors.ImageSharp.dll
Syntax
public static class MetadataExtensions : object

Methods

| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

GetPngMetadata(ImageMetadata)

Gets the png format specific metadata for the image.

Declaration
public static PngMetadata GetPngMetadata(this ImageMetadata metadata)
Parameters
Type Name Description
ImageMetadata metadata

The metadata this method extends.
Returns
Type Description
PngMetadata

The PngMetadata.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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
Boolean

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