Class Pen

The base class for pens that can apply a pattern to a line with a set brush and thickness

Inheritance

Object

Pen

PatternPen

SolidPen

Namespace: SixLabors.ImageSharp.Drawing.Processing

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public abstract class 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

| Improve this Doc View Source

Pen(Brush)

Initializes a new instance of the Pen class.

Declaration

protected Pen(Brush strokeFill)

Parameters

Type	Name	Description
Brush	strokeFill	The brush used to fill the stroke outline.

| Improve this Doc View Source

Pen(Brush, Single)

Initializes a new instance of the Pen class.

Declaration

protected Pen(Brush strokeFill, float strokeWidth)

Parameters

Type	Name	Description
Brush	strokeFill	The brush used to fill the stroke outline.
Single	strokeWidth	The stroke width in px units.

| Improve this Doc View Source

Pen(Brush, Single, Single[])

Initializes a new instance of the Pen class.

Declaration

protected Pen(Brush strokeFill, float strokeWidth, float[] strokePattern)

Parameters

Type	Name	Description
Brush	strokeFill	The brush used to fill the stroke outline.
Single	strokeWidth	The stroke width in px units.
Single[]	strokePattern	The stroke pattern.

| Improve this Doc View Source

Pen(PenOptions)

Initializes a new instance of the Pen class.

Declaration

protected Pen(PenOptions options)

Parameters

Type	Name	Description
PenOptions	options	The pen options.

Properties

| Improve this Doc View Source

EndCapStyle

Gets or sets the end cap style.

Declaration

public EndCapStyle EndCapStyle { get; }

Property Value

Type	Description
EndCapStyle

| Improve this Doc View Source

JointStyle

Gets or sets the joint style.

Declaration

public JointStyle JointStyle { get; }

Property Value

Type	Description
JointStyle

| Improve this Doc View Source

StrokeFill

Gets the brush used to fill the stroke outline. Defaults to SolidBrush.

Declaration

public Brush StrokeFill { get; }

Property Value

Type	Description
Brush

| Improve this Doc View Source

StrokePattern

Gets the stroke pattern.

Declaration

public ReadOnlySpan<float> StrokePattern { get; }

Property Value

Type	Description
ReadOnlySpan<Single>

| Improve this Doc View Source

StrokeWidth

Gets the stroke width in px units. Defaults to 1px.

Declaration

public float StrokeWidth { get; }

Property Value

Type	Description
Single

Methods

| Improve this Doc View Source

Equals(Pen)

Declaration

public virtual bool Equals(Pen other)

Parameters

Type	Name	Description
Pen	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
Nullable<Object>	obj

Returns

Type	Description
Boolean

| Improve this Doc View Source

GeneratePath(IPath)

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

Declaration

public IPath GeneratePath(IPath path)

Parameters

Type	Name	Description
IPath	path	The source path

Returns

Type	Description
IPath	The IPath with the pen styling applied.

| Improve this Doc View Source

GeneratePath(IPath, Single)

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

Declaration

public abstract IPath GeneratePath(IPath path, float strokeWidth)

Parameters

Type	Name	Description
IPath	path	The source path
Single	strokeWidth	The stroke width in px units.

Returns

Type	Description
IPath	The IPath with the pen styling applied.

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32