Class AniMetadata

Namespace

SixLabors.ImageSharp.Formats.Ani

Assembly

SixLabors.ImageSharp.dll

Provides ANI-specific metadata for an image.

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

Inheritance

object

AniMetadata

Implements

IFormatMetadata<AniMetadata>

IFormatMetadata

IDeepCloneable

IDeepCloneable<AniMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AniMetadata()

Initializes a new instance of the AniMetadata class.

public AniMetadata()

Properties

Artist

Gets or sets the animation artist.

public string? Artist { get; set; }

Property Value

string

BitCount

Gets or sets the bits per pixel declared by the ANI header.

public uint BitCount { get; set; }

Property Value

uint

Remarks

Bitmap-based ANI files use this value to describe their raw frame data. Icon-based files commonly store zero because each embedded ICO or CUR entry declares its own pixel layout.

DisplayRate

Gets or sets the default frame display rate in sixtieths of a second.

public uint DisplayRate { get; set; }

Property Value

uint

Flags

Gets or sets the ANI header flags.

public AniHeaderFlags Flags { get; set; }

Property Value

AniHeaderFlags

Height

Gets or sets the frame height declared by the ANI header.

public uint Height { get; set; }

Property Value

uint

Remarks

Icon-based ANI files commonly store zero because each embedded resource declares its own dimensions.

Name

Gets or sets the animation name.

public string? Name { get; set; }

Property Value

string

Planes

Gets or sets the number of independently addressable color planes declared by the ANI header.

public uint Planes { get; set; }

Property Value

uint

Remarks

Bitmap-based ANI files use the Windows DIB plane value, which must be one. Icon-based ANI files use zero because each embedded ICO or CUR entry describes its own pixel layout. No other values are defined by the format.

Width

Gets or sets the frame width declared by the ANI header.

public uint Width { get; set; }

Property Value

uint

Remarks

Icon-based ANI files commonly store zero because each embedded resource declares its own dimensions.

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

public AniMetadata DeepClone()

Returns

AniMetadata

The AniMetadata.

FromFormatConnectingMetadata(FormatConnectingMetadata)

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

public static AniMetadata FromFormatConnectingMetadata(FormatConnectingMetadata metadata)

Parameters

metadata FormatConnectingMetadata

The FormatConnectingMetadata.

Returns

AniMetadata

The AniMetadata.

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.