Class BackgroundColorProcessor

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

Inheritance

Object

BackgroundColorProcessor

Implements

IImageProcessor

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

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class BackgroundColorProcessor : IImageProcessor

Constructors

BackgroundColorProcessor(GraphicsOptions, Color)

Initializes a new instance of the BackgroundColorProcessor class.

Declaration

public BackgroundColorProcessor(GraphicsOptions options, Color color)

Parameters

Type	Name	Description
GraphicsOptions	options	The options defining blending algorithm and amount.
Color	color	The Color to set the background color to.

Properties

Color

Gets the background color value.

Declaration

public Color Color { get; }

Property Value

Type	Description
Color

GraphicsOptions

Gets the Graphics options to alter how processor is applied.

Declaration

public GraphicsOptions GraphicsOptions { get; }

Property Value

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

Declaration

public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle)
    where TPixel : struct, 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