Class PatternPen

Defines a pen that can apply a pattern to a line with a set brush and thickness

Inheritance
object
Pen
PatternPen
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Drawing.Processing
Assembly: SixLabors.ImageSharp.Drawing.dll
Syntax
public class PatternPen : Pen, IEquatable<Pen>
Remarks

The pattern will be in to the form of

new float[]{ 1f, 2f, 0.5f}

this will be converted into a pattern that is 3.5 times longer that the width with 3 sections.

  • Section 1 will be width long (making a square) and will be filled by the brush.
  • Section 2 will be width * 2 long and will be empty.
  • Section 3 will be width/2 long and will be filled.
The pattern will immediately repeat without gap.

Constructors

| Edit this page View Source

PatternPen(Color, float, float[])

Initializes a new instance of the PatternPen class.

Declaration
public PatternPen(Color color, float strokeWidth, float[] strokePattern)
Parameters
Type Name Description
Color color

The color.
float strokeWidth

The stroke width in px units.
float[] strokePattern

The stroke pattern.
| Edit this page View Source

PatternPen(Color, float[])

Initializes a new instance of the PatternPen class.

Declaration
public PatternPen(Color color, float[] strokePattern)
Parameters
Type Name Description
Color color

The color.
float[] strokePattern

The stroke pattern.
| Edit this page View Source

PatternPen(Brush, float, float[])

Initializes a new instance of the PatternPen class.

Declaration
public PatternPen(Brush strokeFill, float strokeWidth, float[] strokePattern)
Parameters
Type Name Description
Brush strokeFill

The brush used to fill the stroke outline.
float strokeWidth

The stroke width in px units.
float[] strokePattern

The stroke pattern.
| Edit this page View Source

PatternPen(PenOptions)

Initializes a new instance of the PatternPen class.

Declaration
public PatternPen(PenOptions options)
Parameters
Type Name Description
PenOptions options

The pen options.

Methods

| Edit this page View Source

Equals(Pen?)

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

Declaration
public override bool Equals(Pen? other)
Parameters
Type Name Description
Pen 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

GeneratePath(IPath, float)

Applies the styling from the pen to a path and generate a new path with the final vector.

Declaration
public override IPath GeneratePath(IPath path, float strokeWidth)
Parameters
Type Name Description
IPath path

The source path
float strokeWidth

The stroke width in px units.
Returns
Type Description
IPath

The IPath with the pen styling applied.
Overrides

Implements