Class IcoFrameMetadata

Namespace

SixLabors.ImageSharp.Formats.Ico

Assembly

SixLabors.ImageSharp.dll

Provides Ico specific metadata information for the image frame.

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

Inheritance

object

IcoFrameMetadata

Implements

IFormatFrameMetadata<IcoFrameMetadata>

IFormatFrameMetadata

IDeepCloneable

IDeepCloneable<IcoFrameMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

IcoFrameMetadata()

Initializes a new instance of the IcoFrameMetadata class.

public IcoFrameMetadata()

Properties

BmpBitsPerPixel

Gets or sets the number of bits per pixel.
Used when Compression is Bmp

public BmpBitsPerPixel BmpBitsPerPixel { get; set; }

Property Value

BmpBitsPerPixel

ColorTable

Gets or sets the color table, if any. The underlying pixel format is represented by Bgr24.

public ReadOnlyMemory<Color>? ColorTable { get; set; }

Property Value

ReadOnlyMemory<Color>?

Compression

Gets or sets the frame compressions format.

public IconFrameCompression Compression { get; set; }

Property Value

IconFrameCompression

EncodingHeight

Gets or sets the encoding height.
Can be any number between 0 and 255. Value 0 means a frame height of 256 pixels or greater.

public byte? EncodingHeight { get; set; }

Property Value

byte?

EncodingWidth

Gets or sets the encoding width.
Can be any number between 0 and 255. Value 0 means a frame height of 256 pixels or greater.

public byte? EncodingWidth { get; set; }

Property Value

byte?

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

public IcoFrameMetadata DeepClone()

Returns

IcoFrameMetadata

The IcoFrameMetadata.

FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata)

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

public static IcoFrameMetadata FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata metadata)

Parameters

metadata FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.

Returns

IcoFrameMetadata

The IcoFrameMetadata.

ToFormatConnectingFrameMetadata()

Converts the metadata to a FormatConnectingFrameMetadata instance.

public FormatConnectingFrameMetadata ToFormatConnectingFrameMetadata()

Returns

FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.