Class ImageProcessor<TPixel>
The base class for all pixel specific image processors. Allows the application of processing algorithms to the image.
Inherited Members
Namespace: SixLabors.ImageSharp.Processing.Processors
Assembly: SixLabors.ImageSharp.dll
Syntax
public abstract class ImageProcessor<TPixel> : IImageProcessor<TPixel>, IDisposable where TPixel : struct, IPixel<TPixel>
Type Parameters
Name | Description |
---|---|
TPixel | The pixel format. |
Constructors
| Improve this Doc View SourceImageProcessor(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
| Improve this Doc View SourceConfiguration
Gets the Configuration instance to use when performing operations.
Declaration
protected Configuration Configuration { get; }
Property Value
Type | Description |
---|---|
Configuration |
Source
Gets The source Image<TPixel> for the current processor instance.
Declaration
protected Image<TPixel> Source { get; }
Property Value
Type | Description |
---|---|
Image<TPixel> |
SourceRectangle
Gets The source area to process for the current processor instance.
Declaration
protected Rectangle SourceRectangle { get; }
Property Value
Type | Description |
---|---|
Rectangle |
Methods
| Improve this Doc View SourceAfterFrameApply(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. |
AfterImageApply()
This method is called after the process is applied to prepare the processor.
Declaration
protected virtual void AfterImageApply()
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. |
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. |
BeforeImageApply()
This method is called before the process is applied to prepare the processor.
Declaration
protected virtual void BeforeImageApply()
Dispose()
Declaration
public void Dispose()
Dispose(Boolean)
Disposes the object and frees resources for the Garbage Collector.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
Boolean | disposing | Whether to dispose managed and unmanaged objects. |
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. |
Explicit Interface Implementations
| Improve this Doc View SourceIImageProcessor<TPixel>.Execute()
Executes the process against the specified Image<TPixel>.
Declaration
void IImageProcessor<TPixel>.Execute()