Class GradientBrush

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

Base class for gradient brushes. Derived brushes define a parameterization that maps each point to a scalar gradient position; this base class maps that position to a color via the sorted color stops and the GradientRepetitionMode.

public abstract class GradientBrush : Brush, IEquatable<Brush>

Inheritance

object

Brush

GradientBrush

Implements

IEquatable<Brush>

Derived

EllipticGradientBrush

LinearGradientBrush

RadialGradientBrush

SweepGradientBrush

Inherited Members

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

Brush.Transform(Matrix4x4, Rectangle, Rectangle)

Brush.Equals(object)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GradientBrush(GradientRepetitionMode, params ColorStop[])

Initializes a new instance of the GradientBrush class.

protected GradientBrush(GradientRepetitionMode repetitionMode, params ColorStop[] colorStops)

Parameters

repetitionMode GradientRepetitionMode

Defines how the colors are repeated beyond the interval [0..1].

colorStops ColorStop[]

The gradient colors.

GradientBrush(GradientRepetitionMode, Matrix4x4, params ColorStop[])

Initializes a new instance of the GradientBrush class.

protected GradientBrush(GradientRepetitionMode repetitionMode, Matrix4x4 gradientTransform, params ColorStop[] colorStops)

Parameters

repetitionMode GradientRepetitionMode

Defines how the colors are repeated beyond the interval [0..1].

gradientTransform Matrix4x4

The transform from the gradient's coordinate space to the drawing.

colorStops ColorStop[]

The gradient colors.

Properties

ColorStops

Gets the color stops for this gradient.

public ReadOnlySpan<ColorStop> ColorStops { get; }

Property Value

ReadOnlySpan<ColorStop>

ColorStopsArray

Gets the color stops array for use by derived applicators.

protected ColorStop[] ColorStopsArray { get; }

Property Value

ColorStop[]

GradientTransform

Gets the transform from the gradient's coordinate space to the drawing. The geometry of the gradient is defined in its own space and every sample is mapped through the inverse of this transform, so a skew or a non-uniform scale changes the shape of the gradient. The transform is affine: a projective transform applied through Transform(Matrix4x4, Rectangle, Rectangle) projects the geometry point by point instead, because an affine gradient cannot express perspective.

public Matrix4x4 GradientTransform { get; }

Property Value

Matrix4x4

RepetitionMode

Gets how the colors are repeated beyond the interval [0..1].

public GradientRepetitionMode RepetitionMode { get; }

Property Value

GradientRepetitionMode

Methods

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.