Class ClipPathProcessor

Allows the recursive application of processing operations against an image within a given region.

Inheritance

object

ClipPathProcessor

Implements

IImageProcessor

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.Processing.Processors.Drawing

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public class ClipPathProcessor : IImageProcessor

Constructors

ClipPathProcessor(DrawingOptions, IPath, Action<IImageProcessingContext>)

Initializes a new instance of the ClipPathProcessor class.

Declaration

public ClipPathProcessor(DrawingOptions options, IPath path, Action<IImageProcessingContext> operation)

Parameters

Type	Name	Description
DrawingOptions	options	The drawing options.
IPath	path	The IPath defining the region to operate within.
Action<IImageProcessingContext>	operation	The operation to perform on the source.

Properties

Operation

Gets the operation to perform on the source.

Declaration

public Action<IImageProcessingContext> Operation { get; }

Property Value

Type	Description
Action<IImageProcessingContext>

Options

Gets the drawing options.

Declaration

public DrawingOptions Options { get; }

Property Value

Type	Description
DrawingOptions

Region

Gets the IPath defining the region to operate within.

Declaration

public IPath Region { get; }

Property Value

Type	Description
IPath

Methods

CreatePixelSpecificProcessor<TPixel>(Configuration, Image<TPixel>, Rectangle)

Creates a pixel specific IImageProcessor<TPixel> that is capable of executing the processing algorithm on an Image<TPixel>.

Declaration

public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle) where TPixel : unmanaged, IPixel<TPixel>

Parameters

Type	Name	Description
Configuration	configuration	The configuration which allows altering default behaviour or extending the library.
Image<TPixel>	source	The source image. Cannot be null.
Rectangle	sourceRectangle	The Rectangle structure that specifies the portion of the image object to draw.

Returns

Type	Description
IImageProcessor<TPixel>	The IImageProcessor<TPixel>

Type Parameters

Name	Description
TPixel	The pixel type.

Implements

IImageProcessor