Class VignetteExtensions

Defines extensions that allow the application of a radial glow to an Image using Mutate/Clone.

Inheritance

Object

VignetteExtensions

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 VignetteExtensions

Methods

Vignette(IImageProcessingContext)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, Color)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, Color color)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
Color	color	The color to set as the vignette.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, Color, Single, Single, Rectangle)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, Color color, float radiusX, float radiusY, Rectangle rectangle)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
Color	color	The color to set as the vignette.
Single	radiusX	The the x-radius.
Single	radiusY	The the y-radius.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, GraphicsOptions)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
GraphicsOptions	options	The options effecting pixel blending.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, GraphicsOptions, Color)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, Color color)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
GraphicsOptions	options	The options effecting pixel blending.
Color	color	The color to set as the vignette.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, GraphicsOptions, Color, Single, Single, Rectangle)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, Color color, float radiusX, float radiusY, Rectangle rectangle)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
GraphicsOptions	options	The options effecting pixel blending.
Color	color	The color to set as the vignette.
Single	radiusX	The the x-radius.
Single	radiusY	The the y-radius.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, GraphicsOptions, Rectangle)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, Rectangle rectangle)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
GraphicsOptions	options	The options effecting pixel blending.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, GraphicsOptions, Single, Single)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, float radiusX, float radiusY)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
GraphicsOptions	options	The options effecting pixel blending.
Single	radiusX	The the x-radius.
Single	radiusY	The the y-radius.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, Rectangle)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, Rectangle rectangle)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
Rectangle	rectangle	The Rectangle structure that specifies the portion of the image object to alter.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.

Vignette(IImageProcessingContext, Single, Single)

Applies a radial vignette effect to an image.

Declaration

public static IImageProcessingContext Vignette(this IImageProcessingContext source, float radiusX, float radiusY)

Parameters

Type	Name	Description
IImageProcessingContext	source	The image this method extends.
Single	radiusX	The the x-radius.
Single	radiusY	The the y-radius.

Returns

Type	Description
IImageProcessingContext	The IImageProcessingContext to allow chaining of operations.