Class JpegMetadata

Namespace

SixLabors.ImageSharp.Formats.Jpeg

Assembly

SixLabors.ImageSharp.dll

Provides Jpeg specific metadata information for the image.

public class JpegMetadata : IFormatMetadata<JpegMetadata>, IFormatMetadata, IDeepCloneable, IDeepCloneable<JpegMetadata>

Inheritance

object

JpegMetadata

Implements

IFormatMetadata<JpegMetadata>

IFormatMetadata

IDeepCloneable

IDeepCloneable<JpegMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

JpegMetadata()

Initializes a new instance of the JpegMetadata class.

public JpegMetadata()

Properties

ColorType

Gets or sets the color type.

public JpegColorType ColorType { get; set; }

Property Value

JpegColorType

Comments

Gets or sets collection of comments.

public IList<JpegComData> Comments { get; set; }

Property Value

IList<JpegComData>

Interleaved

Gets or sets a value indicating whether the component encoding mode should be interleaved.

public bool Interleaved { get; set; }

Property Value

bool

Remarks

Interleaved encoding mode encodes all color components in a single scan. Non-interleaved encoding mode encodes each color component in a separate scan.

Progressive

Gets or sets a value indicating whether the scan encoding mode is progressive.

public bool Progressive { get; set; }

Property Value

bool

Remarks

Progressive jpeg images encode component data across multiple scans.

Quality

Gets or sets the encoded quality.

public int Quality { get; set; }

Property Value

int

Remarks

Note that jpeg image can have different quality for luminance and chrominance components. This property returns maximum value of luma/chroma qualities if both are present. Setting the quality will update both values.

Methods

AfterImageApply<TPixel>(Image<TPixel>, Matrix4x4)

This method is called after a process has been applied to the image.

public void AfterImageApply<TPixel>(Image<TPixel> destination, Matrix4x4 matrix) where TPixel : unmanaged, IPixel<TPixel>

Parameters

destination Image<TPixel>

The destination image .

matrix Matrix4x4

The transformation matrix applied to the image.

Type Parameters

TPixel

The type of pixel format.

DeepClone()

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

public JpegMetadata DeepClone()

Returns

JpegMetadata

The JpegMetadata.

FromFormatConnectingMetadata(FormatConnectingMetadata)

Creates a new instance of the JpegMetadata class from the given FormatConnectingMetadata.

public static JpegMetadata FromFormatConnectingMetadata(FormatConnectingMetadata metadata)

Parameters

metadata FormatConnectingMetadata

The FormatConnectingMetadata.

Returns

JpegMetadata

The JpegMetadata.

GetPixelTypeInfo()

Converts the metadata to a PixelTypeInfo instance.

public PixelTypeInfo GetPixelTypeInfo()

Returns

PixelTypeInfo

The pixel type info.

ToFormatConnectingMetadata()

Converts the metadata to a FormatConnectingMetadata instance.

public FormatConnectingMetadata ToFormatConnectingMetadata()

Returns

FormatConnectingMetadata

The FormatConnectingMetadata.