Class BoxBlurProcessor

Defines a box blur processor of a given radius.

Inheritance

object

BoxBlurProcessor

Implements

IImageProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Processing.Processors.Convolution

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class BoxBlurProcessor : IImageProcessor

Constructors

BoxBlurProcessor()

Initializes a new instance of the BoxBlurProcessor class.

Declaration

public BoxBlurProcessor()

BoxBlurProcessor(int)

Initializes a new instance of the BoxBlurProcessor class.

Declaration

public BoxBlurProcessor(int radius)

Parameters

Type	Name	Description
int	radius	The 'radius' value representing the size of the area to sample.

BoxBlurProcessor(int, BorderWrappingMode, BorderWrappingMode)

Initializes a new instance of the BoxBlurProcessor class.

Declaration

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

Parameters

Type	Name	Description
int	radius	The 'radius' value representing the size of the area to sample.
BorderWrappingMode	borderWrapModeX	The BorderWrappingMode to use when mapping the pixels outside of the border, in X direction.
BorderWrappingMode	borderWrapModeY	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.

Declaration

public const int DefaultRadius = 7

Field Value

Type	Description
int

Properties

BorderWrapModeX

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

Declaration

public BorderWrappingMode BorderWrapModeX { get; }

Property Value

Type	Description
BorderWrappingMode

BorderWrapModeY

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

Declaration

public BorderWrappingMode BorderWrapModeY { get; }

Property Value

Type	Description
BorderWrappingMode

Radius

Gets the Radius.

Declaration

public int Radius { get; }

Property Value

Type	Description
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>.

Declaration

public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle) where TPixel : unmanaged, 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

IImageProcessor