• Articles
  • API Documentation
Search Results for

    Show / Hide Table of Contents
    • SixLabors.ImageSharp.Drawing
      • ArcLineSegment
      • ClipPathExtensions
      • ClippingOperation
      • ComplexPolygon
      • CubicBezierLineSegment
      • EllipsePolygon
      • EmptyPath
      • EndCapStyle
      • ILineSegment
      • IPath
      • IPathCollection
      • ISimplePath
      • IntersectionRule
      • JointStyle
      • LinearLineSegment
      • OutlinePathExtensions
      • Path
      • PathBuilder
      • PathCollection
      • PathExtensions
      • PathTypes
      • Polygon
      • RectangularPolygon
      • RegularPolygon
      • SegmentInfo
      • Star
      • TextBuilder
    • SixLabors.ImageSharp.Drawing.Processing
      • Brush
      • BrushApplicator<TPixel>
      • Brushes
      • ClearExtensions
      • ClearPathExtensions
      • ClearRectangleExtensions
      • ClipPathExtensions
      • ColorStop
      • DrawBezierExtensions
      • DrawLineExtensions
      • DrawPathCollectionExtensions
      • DrawPathExtensions
      • DrawPolygonExtensions
      • DrawRectangleExtensions
      • DrawTextExtensions
      • DrawingOptions
      • DrawingOptionsDefaultsExtensions
      • EllipticGradientBrush
      • FillExtensions
      • FillPathBuilderExtensions
      • FillPathCollectionExtensions
      • FillPathExtensions
      • FillPolygonExtensions
      • FillRectangleExtensions
      • GradientBrush
      • GradientRepetitionMode
      • ImageBrush
      • LinearGradientBrush
      • PathGradientBrush
      • PatternBrush
      • PatternPen
      • Pen
      • PenOptions
      • Pens
      • RadialGradientBrush
      • RecolorBrush
      • RichTextOptions
      • RichTextRun
      • ShapeGraphicOptionsDefaultsExtensions
      • ShapeOptions
      • SolidBrush
      • SolidPen
    • SixLabors.ImageSharp.Drawing.Processing.Processors.Drawing
      • ClipPathProcessor
      • DrawPathProcessor
      • FillPathProcessor
      • FillProcessor
    • SixLabors.ImageSharp.Drawing.Processing.Processors.Text
      • DrawTextProcessor
    • SixLabors.ImageSharp.Drawing.Shapes.PolygonClipper
      • ClipperException
      • ClippingType

    Class Path

    A aggregate of ILineSegments making a single logical path.

    Inheritance
    object
    Path
    Polygon
    Implements
    ISimplePath
    IPath
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: SixLabors.ImageSharp.Drawing
    Assembly: SixLabors.ImageSharp.Drawing.dll
    Syntax
    public class Path : ISimplePath, IPath

    Constructors

    | Edit this page View Source

    Path(params ILineSegment[])

    Initializes a new instance of the Path class.

    Declaration
    public Path(params ILineSegment[] segments)
    Parameters
    Type Name Description
    ILineSegment[] segments

    The segments.

    | Edit this page View Source

    Path(Path)

    Initializes a new instance of the Path class.

    Declaration
    public Path(Path path)
    Parameters
    Type Name Description
    Path path

    The path.

    | Edit this page View Source

    Path(PointF[])

    Initializes a new instance of the Path class.

    Declaration
    public Path(PointF[] points)
    Parameters
    Type Name Description
    PointF[] points

    The collection of points; processed as a series of linear line segments.

    | Edit this page View Source

    Path(IEnumerable<ILineSegment>)

    Initializes a new instance of the Path class.

    Declaration
    public Path(IEnumerable<ILineSegment> segments)
    Parameters
    Type Name Description
    IEnumerable<ILineSegment> segments

    The segments.

    Properties

    | Edit this page View Source

    Bounds

    Gets the bounds enclosing the path.

    Declaration
    public RectangleF Bounds { get; }
    Property Value
    Type Description
    RectangleF
    | Edit this page View Source

    Empty

    Gets the default empty path.

    Declaration
    public static IPath Empty { get; }
    Property Value
    Type Description
    IPath
    | Edit this page View Source

    IsClosed

    Gets a value indicating whether this instance is a closed path.

    Declaration
    public virtual bool IsClosed { get; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    LineSegments

    Gets readonly collection of line segments.

    Declaration
    public IReadOnlyList<ILineSegment> LineSegments { get; }
    Property Value
    Type Description
    IReadOnlyList<ILineSegment>
    | Edit this page View Source

    PathType

    Gets a value indicating whether this instance is closed, open or a composite path with a mixture of open and closed figures.

    Declaration
    public PathTypes PathType { get; }
    Property Value
    Type Description
    PathTypes
    | Edit this page View Source

    Points

    Gets the points that make this up as a simple linear path.

    Declaration
    public ReadOnlyMemory<PointF> Points { get; }
    Property Value
    Type Description
    ReadOnlyMemory<PointF>

    Methods

    | Edit this page View Source

    AsClosedPath()

    Returns this path with all figures closed.

    Declaration
    public IPath AsClosedPath()
    Returns
    Type Description
    IPath

    A new close IPath.

    | Edit this page View Source

    Flatten()

    Converts the IPath into a simple linear path.

    Declaration
    public IEnumerable<ISimplePath> Flatten()
    Returns
    Type Description
    IEnumerable<ISimplePath>

    Returns the current IPath as simple linear path.

    | Edit this page View Source

    Transform(Matrix3x2)

    Transforms the path using the specified matrix.

    Declaration
    public virtual IPath Transform(Matrix3x2 matrix)
    Parameters
    Type Name Description
    Matrix3x2 matrix

    The matrix.

    Returns
    Type Description
    IPath

    A new path with the matrix applied to it.

    | Edit this page View Source

    TryParseSvgPath(ReadOnlySpan<char>, out IPath?)

    Converts an SVG path string into an IPath.

    Declaration
    public static bool TryParseSvgPath(ReadOnlySpan<char> svgPath, out IPath? value)
    Parameters
    Type Name Description
    ReadOnlySpan<char> svgPath

    The string containing the SVG path data.

    IPath value

    When this method returns, contains the logic path converted from the given SVG path string; otherwise, null. This parameter is passed uninitialized.

    Returns
    Type Description
    bool

    true if the input value can be parsed and converted; otherwise, false.

    | Edit this page View Source

    TryParseSvgPath(string, out IPath?)

    Converts an SVG path string into an IPath.

    Declaration
    public static bool TryParseSvgPath(string svgPath, out IPath? value)
    Parameters
    Type Name Description
    string svgPath

    The string containing the SVG path data.

    IPath value

    When this method returns, contains the logic path converted from the given SVG path string; otherwise, null. This parameter is passed uninitialized.

    Returns
    Type Description
    bool

    true if the input value can be parsed and converted; otherwise, false.

    Implements

    ISimplePath
    IPath

    Extension Methods

    ClipPathExtensions.Clip(IPath, params IPath[])
    ClipPathExtensions.Clip(IPath, ShapeOptions, params IPath[])
    ClipPathExtensions.Clip(IPath, ShapeOptions, IEnumerable<IPath>)
    ClipPathExtensions.Clip(IPath, IEnumerable<IPath>)
    OutlinePathExtensions.GenerateOutline(IPath, float)
    OutlinePathExtensions.GenerateOutline(IPath, float, JointStyle, EndCapStyle)
    OutlinePathExtensions.GenerateOutline(IPath, float, ReadOnlySpan<float>)
    OutlinePathExtensions.GenerateOutline(IPath, float, ReadOnlySpan<float>, JointStyle, EndCapStyle)
    OutlinePathExtensions.GenerateOutline(IPath, float, ReadOnlySpan<float>, bool)
    OutlinePathExtensions.GenerateOutline(IPath, float, ReadOnlySpan<float>, bool, JointStyle, EndCapStyle)
    PathExtensions.ComputeLength(IPath)
    PathExtensions.Rotate(IPath, float)
    PathExtensions.RotateDegree(IPath, float)
    PathExtensions.Scale(IPath, float)
    PathExtensions.Scale(IPath, float, float)
    PathExtensions.Translate(IPath, PointF)
    PathExtensions.Translate(IPath, float, float)

    See Also

    IPath
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX