Class VignetteProcessor

Namespace

SixLabors.ImageSharp.Processing.Processors.Overlays

Assembly

SixLabors.ImageSharp.dll

Defines a radial vignette effect applicable to an Image.

public sealed class VignetteProcessor : IImageProcessor

Inheritance

object

VignetteProcessor

Implements

IImageProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

VignetteProcessor(GraphicsOptions, Color)

Initializes a new instance of the VignetteProcessor class.

public VignetteProcessor(GraphicsOptions options, Color color)

Parameters

options GraphicsOptions

The options effecting blending and composition.

color Color

The color of the vignette.

Properties

GraphicsOptions

Gets the options effecting blending and composition

public GraphicsOptions GraphicsOptions { get; }

Property Value

GraphicsOptions

VignetteColor

Gets the vignette color to apply.

public Color VignetteColor { get; }

Property Value

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

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.