Class RecolorBrush

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

Provides an implementation of a brush that can recolor an image. Pixels within Threshold of SourceColor are blended towards TargetColor, with the blend strength falling off as the color distance approaches the threshold.

public sealed class RecolorBrush : Brush, IEquatable<Brush>

Inheritance

object

Brush

RecolorBrush

Implements

IEquatable<Brush>

Inherited Members

Brush.Transform(Matrix4x4, Rectangle, Rectangle)

Brush.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RecolorBrush(Color, Color, float)

Initializes a new instance of the RecolorBrush class.

public RecolorBrush(Color sourceColor, Color targetColor, float threshold)

Parameters

sourceColor Color

The color to match against existing pixels.

targetColor Color

The color to recolor matched pixels with.

threshold float

The color-matching threshold as a value between 0 and 1.

Properties

SourceColor

Gets the color to match against existing pixels.

public Color SourceColor { get; }

Property Value

Color

TargetColor

Gets the color to recolor matched pixels with.

public Color TargetColor { get; }

Property Value

Color

Threshold

Gets the color-matching threshold as a value between 0 and 1.

public float Threshold { get; }

Property Value

float

Methods

CreateRenderer<TPixel>(Configuration, GraphicsOptions, int, RectangleF)

Creates the prepared execution object for this brush.

public override BrushRenderer<TPixel> CreateRenderer<TPixel>(Configuration configuration, GraphicsOptions options, int canvasWidth, RectangleF region) where TPixel : unmanaged, IPixel<TPixel>

Parameters

configuration Configuration

The configuration instance to use when performing operations.

options GraphicsOptions

The graphic options.

canvasWidth int

The canvas width for the current render pass.

region RectangleF

The region the brush will be applied to.

Returns

BrushRenderer<TPixel>

The BrushRenderer<TPixel> for this brush.

Type Parameters

TPixel

The pixel type.

Remarks

The region when being applied to things like shapes would usually be the bounding box of the shape not necessarily the bounds of the whole image.

Equals(Brush?)

Indicates whether the current object is equal to another object of the same type.

public override bool Equals(Brush? other)

Parameters

other Brush

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.