Class ClipPathExtensions

Namespace

SixLabors.ImageSharp.Drawing

Assembly

SixLabors.ImageSharp.Drawing.dll

Provides extension methods to IPath that allow the clipping of shapes.

public static class ClipPathExtensions

Inheritance

object

ClipPathExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Clip(IPath, BooleanOperation, params IPath[])

Clips the specified subject path with the provided clipping paths using NonZero.

public static IPath Clip(this IPath subjectPath, BooleanOperation operation, params IPath[] clipPaths)

Parameters

subjectPath IPath

The subject path.

operation BooleanOperation

The boolean operation to perform.

clipPaths IPath[]

The clipping paths.

Returns

IPath

The clipped IPath.

Clip(IPath, BooleanOperation, IntersectionRule, params IPath[])

Clips the specified subject path with the provided clipping paths.

public static IPath Clip(this IPath subjectPath, BooleanOperation operation, IntersectionRule intersectionRule, params IPath[] clipPaths)

Parameters

subjectPath IPath

The subject path.

operation BooleanOperation

The boolean operation to perform.

intersectionRule IntersectionRule

The fill rule used to interpret the subject and clipping paths.

clipPaths IPath[]

The clipping paths.

Returns

IPath

The clipped IPath.

Clip(IPath, BooleanOperation, IntersectionRule, IEnumerable<IPath>)

Clips the specified subject path with the provided clipping paths.

public static IPath Clip(this IPath subjectPath, BooleanOperation operation, IntersectionRule intersectionRule, IEnumerable<IPath> clipPaths)

Parameters

subjectPath IPath

The subject path.

operation BooleanOperation

The boolean operation to perform.

intersectionRule IntersectionRule

The fill rule used to interpret the subject and clipping paths.

clipPaths IEnumerable<IPath>

The clipping paths.

Returns

IPath

The clipped IPath.

Clip(IPath, BooleanOperation, IEnumerable<IPath>)

Clips the specified subject path with the provided clipping paths using NonZero.

public static IPath Clip(this IPath subjectPath, BooleanOperation operation, IEnumerable<IPath> clipPaths)

Parameters

subjectPath IPath

The subject path.

operation BooleanOperation

The boolean operation to perform.

clipPaths IEnumerable<IPath>

The clipping paths.

Returns

IPath

The clipped IPath.

Clip(IPath, params IPath[])

Clips the specified subject path with the provided clipping paths using Intersection and NonZero.

public static IPath Clip(this IPath subjectPath, params IPath[] clipPaths)

Parameters

subjectPath IPath

The subject path.

clipPaths IPath[]

The clipping paths.

Returns

IPath

The clipped IPath.

Clip(IPath, IEnumerable<IPath>)

Clips the specified subject path with the provided clipping paths using Intersection and NonZero.

public static IPath Clip(this IPath subjectPath, IEnumerable<IPath> clipPaths)

Parameters

subjectPath IPath

The subject path.

clipPaths IEnumerable<IPath>

The clipping paths.

Returns

IPath

The clipped IPath.