Class ImageFrame

Namespace

SixLabors.ImageSharp

Assembly

SixLabors.ImageSharp.dll

Represents a pixel-agnostic image frame containing all pixel data and ImageFrameMetadata. In case of animated formats like gif, it contains the single frame in a animation. In all other cases it is the only frame of the image.

public abstract class ImageFrame : IConfigurationProvider, IDisposable

Inheritance

object

ImageFrame

Implements

IConfigurationProvider

IDisposable

Derived

ImageFrame<TPixel>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ImageFrame(Configuration, int, int, ImageFrameMetadata)

Initializes a new instance of the ImageFrame class.

protected ImageFrame(Configuration configuration, int width, int height, ImageFrameMetadata metadata)

Parameters

configuration Configuration

The configuration which allows altering default behaviour or extending the library.

width int

The frame width.

height int

The frame height.

metadata ImageFrameMetadata

The ImageFrameMetadata.

Properties

Configuration

public Configuration Configuration { get; }

Property Value

Configuration

Height

Gets the height.

public int Height { get; }

Property Value

int

Metadata

Gets the metadata of the frame.

public ImageFrameMetadata Metadata { get; }

Property Value

ImageFrameMetadata

Width

Gets the width.

public int Width { get; }

Property Value

int

Methods

Bounds()

Gets the bounds of the frame.

public Rectangle Bounds()

Returns

Rectangle

The Rectangle

Dispose()

public void Dispose()

Dispose(bool)

Disposes the object and frees resources for the Garbage Collector.

protected abstract void Dispose(bool disposing)

Parameters

disposing bool

Whether to dispose of managed and unmanaged objects.

Size()

Gets the size of the frame.

public Size Size()

Returns

Size

The Size()