Class CurMetadata

Namespace

SixLabors.ImageSharp.Formats.Cur

Assembly

SixLabors.ImageSharp.dll

Provides Cur specific metadata information for the image.

public class CurMetadata : IFormatMetadata<CurMetadata>, IFormatMetadata, IDeepCloneable, IDeepCloneable<CurMetadata>

Inheritance

object

CurMetadata

Implements

IFormatMetadata<CurMetadata>

IFormatMetadata

IDeepCloneable

IDeepCloneable<CurMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CurMetadata()

Initializes a new instance of the CurMetadata class.

public CurMetadata()

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. Derived from the root frame.
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. Derived from the root frame.

public IconFrameCompression Compression { get; set; }

Property Value

IconFrameCompression

Methods

AfterImageApply<TPixel>(Image<TPixel>, Matrix4x4)

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

public void AfterImageApply<TPixel>(Image<TPixel> destination, Matrix4x4 matrix) where TPixel : unmanaged, IPixel<TPixel>

Parameters

destination Image<TPixel>

The destination image .

matrix Matrix4x4

The transformation matrix applied to the image.

Type Parameters

TPixel

The type of pixel format.

DeepClone()

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

public CurMetadata DeepClone()

Returns

CurMetadata

The CurMetadata.

FromFormatConnectingMetadata(FormatConnectingMetadata)

Creates a new instance of the CurMetadata class from the given FormatConnectingMetadata.

public static CurMetadata FromFormatConnectingMetadata(FormatConnectingMetadata metadata)

Parameters

metadata FormatConnectingMetadata

The FormatConnectingMetadata.

Returns

CurMetadata

The CurMetadata.

GetPixelTypeInfo()

Converts the metadata to a PixelTypeInfo instance.

public PixelTypeInfo GetPixelTypeInfo()

Returns

PixelTypeInfo

The pixel type info.

ToFormatConnectingMetadata()

Converts the metadata to a FormatConnectingMetadata instance.

public FormatConnectingMetadata ToFormatConnectingMetadata()

Returns

FormatConnectingMetadata

The FormatConnectingMetadata.