Class BoxBlurExtensions

Defines extensions methods to apply box blurring to an Image using Mutate/Clone.

Inheritance

object

BoxBlurExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Processing

Assembly: SixLabors.ImageSharp.dll

Syntax

public static class BoxBlurExtensions

Methods

BoxBlur(IImageProcessingContext)

Applies a box blur to the image.

Declaration

public static IImageProcessingContext BoxBlur(this IImageProcessingContext source)

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext.

BoxBlur(IImageProcessingContext, int)

Applies a box blur to the image.

Declaration

public static IImageProcessingContext BoxBlur(this IImageProcessingContext source, int radius)

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.
int	radius	The 'radius' value representing the size of the area to sample.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext.

BoxBlur(IImageProcessingContext, int, Rectangle)

Applies a box blur to the image.

Declaration

public static IImageProcessingContext BoxBlur(this IImageProcessingContext source, int radius, Rectangle rectangle)

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.
int	radius	The 'radius' value representing the size of the area to sample.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext.

BoxBlur(IImageProcessingContext, int, Rectangle, BorderWrappingMode, BorderWrappingMode)

Applies a box blur to the image.

Declaration

public static IImageProcessingContext BoxBlur(this IImageProcessingContext source, int radius, Rectangle rectangle, BorderWrappingMode borderWrapModeX, BorderWrappingMode borderWrapModeY)

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.
int	radius	The 'radius' value representing the size of the area to sample.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.
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.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext.