Class WebpFrameMetadata

Namespace

SixLabors.ImageSharp.Formats.Webp

Assembly

SixLabors.ImageSharp.dll

Provides webp specific metadata information for the image frame.

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

Inheritance

object

WebpFrameMetadata

Implements

IFormatFrameMetadata<WebpFrameMetadata>

IFormatFrameMetadata

IDeepCloneable

IDeepCloneable<WebpFrameMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WebpFrameMetadata()

Initializes a new instance of the WebpFrameMetadata class.

public WebpFrameMetadata()

Properties

BlendMode

Gets or sets how transparent pixels of the current frame are to be blended with corresponding pixels of the previous canvas.

public FrameBlendMode BlendMode { get; set; }

Property Value

FrameBlendMode

DisposalMode

Gets or sets how the current frame is to be treated after it has been displayed (before rendering the next frame) on the canvas.

public FrameDisposalMode DisposalMode { get; set; }

Property Value

FrameDisposalMode

FrameDelay

Gets or sets the frame duration. The time to wait before displaying the next frame, in 1 millisecond units. Note the interpretation of frame duration of 0 (and often smaller and equal to 10) is implementation defined.

public uint FrameDelay { get; set; }

Property Value

uint

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

public WebpFrameMetadata DeepClone()

Returns

WebpFrameMetadata

The WebpFrameMetadata.

FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata)

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

public static WebpFrameMetadata FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata metadata)

Parameters

metadata FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.

Returns

WebpFrameMetadata

The WebpFrameMetadata.

ToFormatConnectingFrameMetadata()

Converts the metadata to a FormatConnectingFrameMetadata instance.

public FormatConnectingFrameMetadata ToFormatConnectingFrameMetadata()

Returns

FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.