Class RecolorBrush

Provides an implementation of a brush that can recolor an image

Inheritance
object
Brush
RecolorBrush
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Drawing.Processing
Assembly: SixLabors.ImageSharp.Drawing.dll
Syntax
public sealed class RecolorBrush : Brush, IEquatable<Brush>

Constructors

| Edit this page View Source

RecolorBrush(Color, Color, float)

Initializes a new instance of the RecolorBrush class.

Declaration
public RecolorBrush(Color sourceColor, Color targetColor, float threshold)
Parameters
Type Name Description
Color sourceColor

Color of the source.
Color targetColor

Color of the target.
float threshold

The threshold as a value between 0 and 1.

Properties

| Edit this page View Source

SourceColor

Gets the source color.

Declaration
public Color SourceColor { get; }
Property Value
Type Description
Color
| Edit this page View Source

TargetColor

Gets the target color.

Declaration
public Color TargetColor { get; }
Property Value
Type Description
Color
| Edit this page View Source

Threshold

Gets the threshold.

Declaration
public float Threshold { get; }
Property Value
Type Description
float

Methods

| Edit this page View Source

CreateApplicator<TPixel>(Configuration, GraphicsOptions, ImageFrame<TPixel>, RectangleF)

Creates the applicator for this brush.

Declaration
public override BrushApplicator<TPixel> CreateApplicator<TPixel>(Configuration configuration, GraphicsOptions options, ImageFrame<TPixel> source, RectangleF region) where TPixel : unmanaged, IPixel<TPixel>
Parameters
Type Name Description
Configuration configuration

The configuration instance to use when performing operations.
GraphicsOptions options

The graphic options.
ImageFrame<TPixel> source

The source image.
RectangleF region

The region the brush will be applied to.
Returns
Type Description
BrushApplicator<TPixel>

The BrushApplicator<TPixel> for this brush.
Type Parameters
Name Description
TPixel

The pixel type.
Overrides
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.

| Edit this page View Source

Equals(Brush?)

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

Declaration
public override bool Equals(Brush? other)
Parameters
Type Name Description
Brush other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
Overrides
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements