Class VignetteProcessor

Defines a radial vignette effect applicable to an Image.

Inheritance

object

VignetteProcessor

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.Overlays

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class VignetteProcessor : IImageProcessor

Constructors

VignetteProcessor(GraphicsOptions, Color)

Initializes a new instance of the VignetteProcessor class.

Declaration

public VignetteProcessor(GraphicsOptions options, Color color)

Parameters

Type	Name	Description
GraphicsOptions	options	The options effecting blending and composition.
Color	color	The color of the vignette.

Properties

GraphicsOptions

Gets the options effecting blending and composition

Declaration

public GraphicsOptions GraphicsOptions { get; }

Property Value

Type	Description
GraphicsOptions

VignetteColor

Gets the vignette color to apply.

Declaration

public Color VignetteColor { get; }

Property Value

Type	Description
Color

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