Class FormatConnectingMetadata

Namespace

SixLabors.ImageSharp.Formats

Assembly

SixLabors.ImageSharp.dll

A metadata format designed to allow conversion between different image formats.

public class FormatConnectingMetadata

Inheritance

object

FormatConnectingMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AnimateRootFrame

Gets a value indicating whether the root frame is shown as part of the animated sequence.

public bool AnimateRootFrame { get; init; }

Property Value

bool

Remarks

Defaults to true.

BackgroundColor

Gets the default background color of the canvas when animating. This color may be used to fill the unused space on the canvas around the frames, as well as the transparent pixels of the first frame. The background color is also used when a frame disposal mode is RestoreToBackground.

public Color BackgroundColor { get; init; }

Property Value

Color

Remarks

Defaults to Transparent.

ColorTableMode

Gets the shared color table mode.

public FrameColorTableMode ColorTableMode { get; init; }

Property Value

FrameColorTableMode

Remarks

Defaults to Global.

EncodingType

Gets the encoding type.

public EncodingType EncodingType { get; init; }

Property Value

EncodingType

PixelTypeInfo

Gets information about the encoded pixel type.

public PixelTypeInfo PixelTypeInfo { get; init; }

Property Value

PixelTypeInfo

Quality

Gets the quality to use when EncodingType is Lossy.

public int Quality { get; init; }

Property Value

int

Remarks

The value is usually between 1 and 100. Defaults to 100.

RepeatCount

Gets the number of times any animation is repeated.

public ushort RepeatCount { get; init; }

Property Value

ushort

Remarks

0 means to repeat indefinitely, count is set as repeat n-1 times. Defaults to 1.