Class CurFrameMetadata

Namespace

SixLabors.ImageSharp.Formats.Cur

Assembly

SixLabors.ImageSharp.dll

IcoFrameMetadata.

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

Inheritance

object

CurFrameMetadata

Implements

IFormatFrameMetadata<CurFrameMetadata>

IFormatFrameMetadata

IDeepCloneable

IDeepCloneable<CurFrameMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CurFrameMetadata()

Initializes a new instance of the CurFrameMetadata class.

public CurFrameMetadata()

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?

HotspotX

Gets or sets the horizontal coordinates of the hotspot in number of pixels from the left.

public ushort HotspotX { get; set; }

Property Value

ushort

HotspotY

Gets or sets the vertical coordinates of the hotspot in number of pixels from the top.

public ushort HotspotY { get; set; }

Property Value

ushort

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

public CurFrameMetadata DeepClone()

Returns

CurFrameMetadata

The CurFrameMetadata.

FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata)

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

public static CurFrameMetadata FromFormatConnectingFrameMetadata(FormatConnectingFrameMetadata metadata)

Parameters

metadata FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.

Returns

CurFrameMetadata

The CurFrameMetadata.

ToFormatConnectingFrameMetadata()

Converts the metadata to a FormatConnectingFrameMetadata instance.

public FormatConnectingFrameMetadata ToFormatConnectingFrameMetadata()

Returns

FormatConnectingFrameMetadata

The FormatConnectingFrameMetadata.