Skip to content

GraphicsAPI reference

Class AtlasAnimation

Namespace: MicroEngine.Graphics
Assembly: MicroEngine.Graphics2D.dll
Guide: Graphics

A named run of frames (an Aseprite frame tag).

C#
public sealed record AtlasAnimation : IEquatable<AtlasAnimation>

Inheritance

object ← AtlasAnimation

Implements

IEquatable<AtlasAnimation>

Constructors

AtlasAnimation(string, int, int, AnimationDirection)

A named run of frames (an Aseprite frame tag).

C#
public AtlasAnimation(string Name, int From, int To, AnimationDirection Direction)

Parameters

Name string

The tag’s name.

From int

Index of the first frame in Regions.

To int

Index of the last frame, inclusive.

Direction AnimationDirection

How the frames play.

Properties

Direction

How the frames play.

C#
public AnimationDirection Direction { get; init; }

Property Value

AnimationDirection

From

Index of the first frame in Regions.

C#
public int From { get; init; }

Property Value

int

Name

The tag’s name.

C#
public string Name { get; init; }

Property Value

string

To

Index of the last frame, inclusive.

C#
public int To { get; init; }

Property Value

int

Methods

<Clone>$()

C#
public AtlasAnimation <Clone>$()

Returns

AtlasAnimation

Deconstruct(out string, out int, out int, out AnimationDirection)

C#
public void Deconstruct(out string Name, out int From, out int To, out AnimationDirection Direction)

Parameters

Name string

From int

To int

Direction AnimationDirection

Equals(object?)

C#
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(AtlasAnimation?)

C#
public bool Equals(AtlasAnimation? other)

Parameters

other AtlasAnimation?

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(AtlasAnimation?, AtlasAnimation?)

C#
public static bool operator ==(AtlasAnimation? left, AtlasAnimation? right)

Parameters

left AtlasAnimation?

right AtlasAnimation?

Returns

bool

operator !=(AtlasAnimation?, AtlasAnimation?)

C#
public static bool operator !=(AtlasAnimation? left, AtlasAnimation? right)

Parameters

left AtlasAnimation?

right AtlasAnimation?

Returns

bool