Class RadialGradientBrush

A radial gradient brush, defined by center point and radius.

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

Constructors

| Edit this page View Source

RadialGradientBrush(PointF, float, GradientRepetitionMode, params ColorStop[])

Base class for Gradient brushes

Declaration
public RadialGradientBrush(PointF center, float radius, GradientRepetitionMode repetitionMode, params ColorStop[] colorStops)
Parameters
Type Name Description
PointF center

The center of the circular gradient and 0 for the color stops.
float radius

The radius of the circular gradient and 1 for the color stops.
GradientRepetitionMode repetitionMode

Defines how the colors in the gradient are repeated.
ColorStop[] colorStops

the color stops as defined in base class.

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