Class ImageProcessor<TPixel>

The base class for all pixel specific image processors. Allows the application of processing algorithms to the image.

Inheritance
object
ImageProcessor<TPixel>
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Processing.Processors
Assembly: SixLabors.ImageSharp.dll
Syntax
public abstract class ImageProcessor<TPixel> : IImageProcessor<TPixel>, IDisposable where TPixel : unmanaged, IPixel<TPixel>
Type Parameters
Name Description
TPixel

The pixel format.

Constructors

| Edit this page View Source

ImageProcessor(Configuration, Image<TPixel>, Rectangle)

Initializes a new instance of the ImageProcessor<TPixel> class.

Declaration
protected ImageProcessor(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle)
Parameters
Type Name Description
Configuration configuration

The configuration which allows altering default behaviour or extending the library.
Image<TPixel> source

The source Image<TPixel> for the current processor instance.
Rectangle sourceRectangle

The source area to process for the current processor instance.

Properties

| Edit this page View Source

Configuration

Gets the Configuration instance to use when performing operations.

Declaration
protected Configuration Configuration { get; }
Property Value
Type Description
Configuration
| Edit this page View Source

Source

Gets The source Image<TPixel> for the current processor instance.

Declaration
protected Image<TPixel> Source { get; }
Property Value
Type Description
Image<TPixel>
| Edit this page View Source

SourceRectangle

Gets The source area to process for the current processor instance.

Declaration
protected Rectangle SourceRectangle { get; }
Property Value
Type Description
Rectangle

Methods

| Edit this page View Source

AfterFrameApply(ImageFrame<TPixel>)

This method is called after the process is applied to prepare the processor.

Declaration
protected virtual void AfterFrameApply(ImageFrame<TPixel> source)
Parameters
Type Name Description
ImageFrame<TPixel> source

The source image. Cannot be null.
| Edit this page View Source

AfterImageApply()

This method is called after the process is applied to prepare the processor.

Declaration
protected virtual void AfterImageApply()
| Edit this page View Source

Apply(ImageFrame<TPixel>)

Applies the processor to a single image frame.

Declaration
public void Apply(ImageFrame<TPixel> source)
Parameters
Type Name Description
ImageFrame<TPixel> source

the source image.
| Edit this page View Source

BeforeFrameApply(ImageFrame<TPixel>)

This method is called before the process is applied to prepare the processor.

Declaration
protected virtual void BeforeFrameApply(ImageFrame<TPixel> source)
Parameters
Type Name Description
ImageFrame<TPixel> source

The source image. Cannot be null.
| Edit this page View Source

BeforeImageApply()

This method is called before the process is applied to prepare the processor.

Declaration
protected virtual void BeforeImageApply()
| Edit this page View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
| Edit this page View Source

Dispose(bool)

Disposes the object and frees resources for the Garbage Collector.

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

Whether to dispose managed and unmanaged objects.
| Edit this page View Source

OnFrameApply(ImageFrame<TPixel>)

Applies the process to the specified portion of the specified ImageFrame<TPixel> at the specified location and with the specified size.

Declaration
protected abstract void OnFrameApply(ImageFrame<TPixel> source)
Parameters
Type Name Description
ImageFrame<TPixel> source

The source image. Cannot be null.

Implements