Class BackgroundColorProcessor

Namespace

SixLabors.ImageSharp.Processing.Processors.Overlays

Assembly

SixLabors.ImageSharp.dll

Defines a processing operation to replace the background color of an Image.

public sealed class BackgroundColorProcessor : IImageProcessor

Inheritance

object

BackgroundColorProcessor

Implements

IImageProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BackgroundColorProcessor(GraphicsOptions, Color)

Initializes a new instance of the BackgroundColorProcessor class.

public BackgroundColorProcessor(GraphicsOptions options, Color color)

Parameters

options GraphicsOptions

The options defining blending algorithm and amount.

color Color

The Color to set the background color to.

Properties

Color

Gets the background color value.

public Color Color { get; }

Property Value

Color

GraphicsOptions

Gets the Graphics options to alter how processor is applied.

public GraphicsOptions GraphicsOptions { get; }

Property Value

GraphicsOptions

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.