Class GifFrameMetadata

Provides Gif specific metadata information for the image frame.

Inheritance

object

GifFrameMetadata

Implements

IDeepCloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Formats.Gif

Assembly: SixLabors.ImageSharp.dll

Syntax

public class GifFrameMetadata : IDeepCloneable

Constructors

GifFrameMetadata()

Initializes a new instance of the GifFrameMetadata class.

Declaration

public GifFrameMetadata()

Properties

ColorTableMode

Gets or sets the color table mode.

Declaration

public GifColorTableMode ColorTableMode { get; set; }

Property Value

Type	Description
GifColorTableMode

DisposalMethod

Gets or sets the disposal method for animated images. Primarily used in Gif animation, this field indicates the way in which the graphic is to be treated after being displayed.

Declaration

public GifDisposalMethod DisposalMethod { get; set; }

Property Value

Type	Description
GifDisposalMethod

FrameDelay

Gets or sets the frame delay for animated images. If not 0, when utilized in Gif animation, this field specifies the number of hundredths (1/100) of a second to wait before continuing with the processing of the Data Stream. The clock starts ticking immediately after the graphic is rendered.

Declaration

public int FrameDelay { get; set; }

Property Value

Type	Description
int

HasTransparency

Gets or sets a value indicating whether the frame has transparency

Declaration

public bool HasTransparency { get; set; }

Property Value

Type	Description
bool

LocalColorTable

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

Declaration

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

Property Value

Type	Description
ReadOnlyMemory<Color>?

TransparencyIndex

Gets or sets the transparency index. When HasTransparency is set to true this value indicates the index within the color palette at which the transparent color is located.

Declaration

public byte TransparencyIndex { get; set; }

Property Value

Type	Description
byte

Methods

DeepClone()

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

Declaration

public IDeepCloneable DeepClone()

Returns

Type	Description
IDeepCloneable	The IDeepCloneable.

Implements

IDeepCloneable