Class ImageFrame

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.

Inheritance
Object
ImageFrame
ImageFrame<TPixel>
Implements
Inherited Members
Namespace: SixLabors.ImageSharp
Assembly: SixLabors.ImageSharp.dll
Syntax
public abstract class ImageFrame : IDisposable

Constructors

| Improve this Doc View Source

ImageFrame(Configuration, Int32, Int32, ImageFrameMetadata)

Initializes a new instance of the ImageFrame class.

Declaration
protected ImageFrame(Configuration configuration, int width, int height, ImageFrameMetadata metadata)
Parameters
Type Name Description
Configuration configuration

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

The frame width.
Int32 height

The frame height.
ImageFrameMetadata metadata

The ImageFrameMetadata.

Properties

| Improve this Doc View Source

Height

Gets the height.

Declaration
public int Height { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Metadata

Gets the metadata of the frame.

Declaration
public ImageFrameMetadata Metadata { get; }
Property Value
Type Description
ImageFrameMetadata
| Improve this Doc View Source

Width

Gets the width.

Declaration
public int Width { get; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

Bounds()

Gets the bounds of the frame.

Declaration
public Rectangle Bounds()
Returns
Type Description
Rectangle

The Rectangle
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Disposes the object and frees resources for the Garbage Collector.

Declaration
protected abstract void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

Whether to dispose of managed and unmanaged objects.
| Improve this Doc View Source

Size()

Gets the size of the frame.

Declaration
public Size Size()
Returns
Type Description
Size

The Size()

Implements

Extension Methods