Class BoxBlurProcessor

Namespace

SixLabors.ImageSharp.Processing.Processors.Convolution

Assembly

SixLabors.ImageSharp.dll

Defines a box blur processor of a given radius.

public sealed class BoxBlurProcessor : IImageProcessor

Inheritance

object

BoxBlurProcessor

Implements

IImageProcessor

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BoxBlurProcessor()

Initializes a new instance of the BoxBlurProcessor class.

public BoxBlurProcessor()

BoxBlurProcessor(int)

Initializes a new instance of the BoxBlurProcessor class.

public BoxBlurProcessor(int radius)

Parameters

radius int

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

BoxBlurProcessor(int, BorderWrappingMode, BorderWrappingMode)

Initializes a new instance of the BoxBlurProcessor class.

public BoxBlurProcessor(int radius, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)

Parameters

radius int

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

borderWrapModeX BorderWrappingMode

The BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.

borderWrapModeY BorderWrappingMode

The BorderWrappingMode to use when mapping the pixels outside of the border, in Y direction.

Fields

DefaultRadius

The default radius used by the parameterless constructor.

public const int DefaultRadius = 7

Field Value

int

Properties

BorderWrapModeX

Gets the BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.

public BorderWrappingMode BorderWrapModeX { get; }

Property Value

BorderWrappingMode

BorderWrapModeY

Gets the BorderWrappingMode to use when mapping the pixels outside of the border, in Y direction.

public BorderWrappingMode BorderWrapModeY { get; }

Property Value

BorderWrappingMode

Radius

Gets the Radius.

public int Radius { get; }

Property Value

int

Methods

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

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

public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration

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

source Image<TPixel>

The source image. Cannot be null.

sourceRectangle Rectangle

The Rectangle structure that specifies the portion of the image object to draw.

Returns

IImageProcessor<TPixel>

The IImageProcessor<TPixel>

Type Parameters

TPixel

The pixel type.