Class AniDetails

Namespace

Egami.Formats.Ani

Assembly

Egami.dll

Details only ANI has, kept in FormatDetails. Each frame's own hotspot, entry and depth are in its FormatDetails, an IcoDetails.

public sealed class AniDetails : FormatDetails

Inheritance

object

FormatDetails

AniDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

// Probe reads the chunks and each frame's directory without decoding a pixel.
RasterInfo info = Raster.Probe("busy.ani");
Console.WriteLine($"{info.FrameCount} steps; {info.ImageCount} sizes; Load gives {info.Width}×{info.Height}");

// The steps replay the stored frames in the file's order; a frame can show more than once.
using Raster busy = Raster.Load("busy.ani");
AniDetails details = (AniDetails)busy.Metadata.FormatDetails!;
Console.WriteLine($"\"{details.Title}\" by {details.Artist}: {details.StoredFrames} frames stored, steps {string.Join(", ", details.Steps)}");

Properties

Artist

Gets or sets the artist from the file's INFO list, or null.

public string? Artist { get; set; }

Property Value

string

DefaultDelay

Gets or sets the display time of a step that has none of its own: the header's default rate.

public TimeSpan DefaultDelay { get; set; }

Property Value

TimeSpan

RawBitmaps

Gets or sets whether the frames are raw bitmaps rather than icons or cursors, which old files sometimes are.

public bool RawBitmaps { get; set; }

Property Value

bool

Sizes

Gets or sets every size the stored frames hold, largest first, as LoadAll(Stream, EgamiContext?, ReaderOptions?) returns them.

public IReadOnlyList<Size> Sizes { get; set; }

Property Value

IReadOnlyList<Size>

Steps

Gets or sets the stored frame each step shows, in playing order: the file's seq list, or 0, 1, 2 and so on without one. Steps whose frame could not be read are left out.

public IReadOnlyList<int> Steps { get; set; }

Property Value

IReadOnlyList<int>

StoredFrames

Gets or sets how many frames the file stores; steps may show a stored frame more than once.

public int StoredFrames { get; set; }

Property Value

int

Title

Gets or sets the title from the file's INFO list, or null.

public string? Title { get; set; }

Property Value

string

Methods

Copy()

Returns a deep copy.

public override FormatDetails Copy()

Returns

FormatDetails

The copy.