Class GifMetadata

Namespace

SixLabors.ImageSharp.Formats.Gif

Assembly

SixLabors.ImageSharp.dll

Provides Gif specific metadata information for the image.

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

Inheritance

object

GifMetadata

Implements

IFormatMetadata<GifMetadata>

IFormatMetadata

IDeepCloneable

IDeepCloneable<GifMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GifMetadata()

Initializes a new instance of the GifMetadata class.

public GifMetadata()

Properties

BackgroundColorIndex

Gets or sets the index at the GlobalColorTable for the background color. The background color is the color used for those pixels on the screen that are not covered by an image.

public byte BackgroundColorIndex { get; set; }

Property Value

byte

ColorTableMode

Gets or sets the color table mode.

public FrameColorTableMode ColorTableMode { get; set; }

Property Value

FrameColorTableMode

Comments

Gets or sets the collection of comments about the graphics, credits, descriptions or any other type of non-control and non-graphic data.

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

Property Value

IList<string>

GlobalColorTable

Gets or sets the global color table, if any. The underlying pixel format is represented by Rgb24.

public ReadOnlyMemory<Color>? GlobalColorTable { get; set; }

Property Value

ReadOnlyMemory<Color>?

RepeatCount

Gets or sets the number of times any animation is repeated. 0 means to repeat indefinitely, count is set as repeat n-1 times. Defaults to 1.

public ushort RepeatCount { get; set; }

Property Value

ushort

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 GifMetadata that is a deep copy of the current instance.

public GifMetadata DeepClone()

Returns

GifMetadata

The GifMetadata.

FromFormatConnectingMetadata(FormatConnectingMetadata)

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

public static GifMetadata FromFormatConnectingMetadata(FormatConnectingMetadata metadata)

Parameters

metadata FormatConnectingMetadata

The FormatConnectingMetadata.

Returns

GifMetadata

The GifMetadata.

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.