Class ImageMetadata

Encapsulates the metadata of an image.

Inheritance
Object
ImageMetadata
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Metadata
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class ImageMetadata : IDeepCloneable<ImageMetadata>

Constructors

| Improve this Doc View Source

ImageMetadata()

Initializes a new instance of the ImageMetadata class.

Declaration
public ImageMetadata()

Fields

| Improve this Doc View Source

DefaultHorizontalResolution

The default horizontal resolution value (dots per inch) in x direction. The default value is 96 PixelsPerInch.

Declaration
public const double DefaultHorizontalResolution = 96
Field Value
Type Description
Double
| Improve this Doc View Source

DefaultPixelResolutionUnits

The default pixel resolution units. The default value is PixelsPerInch.

Declaration
public const PixelResolutionUnit DefaultPixelResolutionUnits = PixelResolutionUnit.PixelsPerInch
Field Value
Type Description
PixelResolutionUnit
| Improve this Doc View Source

DefaultVerticalResolution

The default vertical resolution value (dots per inch) in y direction. The default value is 96 PixelsPerInch.

Declaration
public const double DefaultVerticalResolution = 96
Field Value
Type Description
Double

Properties

| Improve this Doc View Source

ExifProfile

Gets or sets the Exif profile.

Declaration
public ExifProfile ExifProfile { get; set; }
Property Value
Type Description
ExifProfile
| Improve this Doc View Source

HorizontalResolution

Gets or sets the resolution of the image in x- direction. It is defined as the number of dots per ResolutionUnits and should be an positive value.

Declaration
public double HorizontalResolution { get; set; }
Property Value
Type Description
Double

The density of the image in x- direction.
| Improve this Doc View Source

IccProfile

Gets or sets the list of ICC profiles.

Declaration
public IccProfile IccProfile { get; set; }
Property Value
Type Description
IccProfile
| Improve this Doc View Source

IptcProfile

Gets or sets the IPTC profile.

Declaration
public IptcProfile IptcProfile { get; set; }
Property Value
Type Description
IptcProfile
| Improve this Doc View Source

ResolutionUnits

Gets or sets unit of measure used when reporting resolution.

ValueUnit
AspectRatio (00)No units; width:height pixel aspect ratio = Ydensity:Xdensity
PixelsPerInch (01)Pixels per inch (2.54 cm)
PixelsPerCentimeter (02)Pixels per centimeter
PixelsPerMeter (03)Pixels per meter (100 cm)

Declaration
public PixelResolutionUnit ResolutionUnits { get; set; }
Property Value
Type Description
PixelResolutionUnit
| Improve this Doc View Source

VerticalResolution

Gets or sets the resolution of the image in y- direction. It is defined as the number of dots per ResolutionUnits and should be an positive value.

Declaration
public double VerticalResolution { get; set; }
Property Value
Type Description
Double

The density of the image in y- direction.
| Improve this Doc View Source

XmpProfile

Gets or sets the XMP profile.

Declaration
public XmpProfile XmpProfile { get; set; }
Property Value
Type Description
XmpProfile

Methods

| Improve this Doc View Source

DeepClone()

Creates a new T that is a deep copy of the current instance.

Declaration
public ImageMetadata DeepClone()
Returns
Type Description
ImageMetadata

The T.
| Improve this Doc View Source

GetFormatMetadata<TFormatMetadata>(IImageFormat<TFormatMetadata>)

Gets the metadata value associated with the specified key.

Declaration
public TFormatMetadata GetFormatMetadata<TFormatMetadata>(IImageFormat<TFormatMetadata> key)
    where TFormatMetadata : class, IDeepCloneable
Parameters
Type Name Description
IImageFormat<TFormatMetadata> key

The key of the value to get.
Returns
Type Description
TFormatMetadata

The TFormatMetadata.
Type Parameters
Name Description
TFormatMetadata

The type of metadata.

Implements

Extension Methods