Class AnimatedImageEncoder

Namespace

SixLabors.ImageSharp.Formats

Assembly

SixLabors.ImageSharp.dll

Acts as a base class for all image encoders that allow encoding animation sequences.

public abstract class AnimatedImageEncoder : AlphaAwareImageEncoder, IImageEncoder, IAnimatedImageEncoder

Inheritance

object

ImageEncoder

AlphaAwareImageEncoder

AnimatedImageEncoder

Implements

IImageEncoder

IAnimatedImageEncoder

Derived

WebpEncoder

Inherited Members

AlphaAwareImageEncoder.TransparentColorMode

ImageEncoder.SkipMetadata

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream)

ImageEncoder.EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AnimateRootFrame

Gets a value indicating whether the root frame is shown as part of the animated sequence in supported encoders.

public bool? AnimateRootFrame { get; init; }

Property Value

bool?

BackgroundColor

Gets the default background color of the canvas when animating in supported encoders. This color may be used to fill the unused space on the canvas around the frames, as well as the transparent pixels of the first frame. The background color is also used when a frame disposal mode is RestoreToBackground.

public Color? BackgroundColor { get; init; }

Property Value

Color?

RepeatCount

Gets the number of times any animation is repeated in supported encoders.

public ushort? RepeatCount { get; init; }

Property Value

ushort?