Class LinearGradientBrush

Provides an implementation of a brush for painting linear gradients within areas. Supported right now:

  • a set of colors in relative distances to each other.
Inheritance
Object
Brush
GradientBrush
LinearGradientBrush
Inherited Members
Namespace: SixLabors.ImageSharp.Drawing.Processing
Assembly: SixLabors.ImageSharp.Drawing.dll
Syntax
public sealed class LinearGradientBrush : GradientBrush

Constructors

| Improve this Doc View Source

LinearGradientBrush(PointF, PointF, GradientRepetitionMode, ColorStop[])

Initializes a new instance of the LinearGradientBrush class.

Declaration
public LinearGradientBrush(PointF p1, PointF p2, GradientRepetitionMode repetitionMode, params ColorStop[] colorStops)
Parameters
Type Name Description
PointF p1

Start point
PointF p2

End point
GradientRepetitionMode repetitionMode

defines how colors are repeated.
ColorStop[] colorStops

Methods

| Improve this Doc 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 : struct, 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
SixLabors.ImageSharp.Drawing.Processing.Brush.CreateApplicator<TPixel>(Configuration, GraphicsOptions, ImageFrame<TPixel>, RectangleF)
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.

| Improve this Doc View Source

Equals(Brush)

Declaration
public override bool Equals(Brush other)
Parameters
Type Name Description
Brush other
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides