Class PngFrameMetadata

Namespace

SixLabors.ImageSharp.Formats.Png

Assembly

SixLabors.ImageSharp.dll

Provides APng specific metadata information for the image frame.

public class PngFrameMetadata : IFormatFrameMetadata<PngFrameMetadata>, IFormatFrameMetadata, IDeepCloneable, IDeepCloneable<PngFrameMetadata>

Inheritance

object

PngFrameMetadata

Implements

IFormatFrameMetadata<PngFrameMetadata>

IFormatFrameMetadata

IDeepCloneable

IDeepCloneable<PngFrameMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PngFrameMetadata()

Initializes a new instance of the PngFrameMetadata class.

public PngFrameMetadata()

Properties

BlendMode

Gets or sets the type of frame area rendering for this frame

public FrameBlendMode BlendMode { get; set; }

Property Value

FrameBlendMode

DisposalMode

Gets or sets the type of frame area disposal to be done after rendering this frame

public FrameDisposalMode DisposalMode { get; set; }

Property Value

FrameDisposalMode

FrameDelay

Gets or sets the frame delay for animated images. If not 0, when utilized in Png animation, this field specifies the number of seconds to wait before continuing with the processing of the Data Stream. The clock starts ticking immediately after the graphic is rendered.

public Rational FrameDelay { get; set; }

Property Value

Rational

Methods

AfterFrameApply<TPixel>(ImageFrame<TPixel>, ImageFrame<TPixel>, Matrix4x4)

This method is called after a process has been applied to the image frame.

public void AfterFrameApply<TPixel>(ImageFrame<TPixel> source, ImageFrame<TPixel> destination, Matrix4x4 matrix) where TPixel : unmanaged, IPixel<TPixel>

Parameters

source ImageFrame<TPixel>

The source image frame.

destination ImageFrame<TPixel>

The destination image frame.

matrix Matrix4x4

The transformation matrix applied to the image frame.

Type Parameters

TPixel

The type of pixel format.

DeepClone()

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

public PngFrameMetadata DeepClone()

Returns

PngFrameMetadata

The PngFrameMetadata.

FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata)

Creates a new instance of the PngFrameMetadata class from the given FormatConnectingFrameMetadata.

public static PngFrameMetadata FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata metadata)

Parameters

metadata FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.

Returns

PngFrameMetadata

The PngFrameMetadata.

ToFormatConnectingFrameMetadata()

Converts the metadata to a FormatConnectingFrameMetadata instance.

public FormatConnectingFrameMetadata ToFormatConnectingFrameMetadata()

Returns

FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.