Class BoxBlurProcessor

Defines a box blur processor of a given radius.

Inheritance
Object
BoxBlurProcessor
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Processing.Processors.Convolution
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class BoxBlurProcessor : IImageProcessor

Constructors

| Improve this Doc View Source

BoxBlurProcessor()

Initializes a new instance of the BoxBlurProcessor class.

Declaration
public BoxBlurProcessor()
| Improve this Doc View Source

BoxBlurProcessor(Int32)

Initializes a new instance of the BoxBlurProcessor class.

Declaration
public BoxBlurProcessor(int radius)
Parameters
Type Name Description
Int32 radius

The 'radius' value representing the size of the area to sample.

Fields

| Improve this Doc View Source

DefaultRadius

The default radius used by the parameterless constructor.

Declaration
public const int DefaultRadius = 7
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

Radius

Gets the Radius.

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

Methods

| Improve this Doc View Source

CreatePixelSpecificProcessor<TPixel>(Configuration, Image<TPixel>, Rectangle)

Creates a pixel specific IImageProcessor<TPixel> that is capable of executing the processing algorithm on an Image<TPixel>.

Declaration
public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle)
    where TPixel : struct, IPixel<TPixel>
Parameters
Type Name Description
Configuration configuration

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

The source image. Cannot be null.
Rectangle sourceRectangle

The Rectangle structure that specifies the portion of the image object to draw.
Returns
Type Description
IImageProcessor<TPixel>

The IImageProcessor<TPixel>
Type Parameters
Name Description
TPixel

The pixel type.

Implements