Class DrawingCanvas<TPixel>

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

A drawing canvas over a frame target.

public sealed class DrawingCanvas<TPixel> : DrawingCanvas, IDisposable where TPixel : unmanaged, IPixel<TPixel>

Type Parameters

TPixel

The pixel format.

Inheritance

object

DrawingCanvas

DrawingCanvas<TPixel>

Implements

IDisposable

Inherited Members

DrawingCanvas.SaveLayer()

DrawingCanvas.SaveLayer(GraphicsOptions)

DrawingCanvas.Fill(Brush)

DrawingCanvas.Fill(Brush, Rectangle)

DrawingCanvas.Clear(Brush)

DrawingCanvas.Clear(Brush, Rectangle)

DrawingCanvas.Fill(Brush, IPathCollection)

DrawingCanvas.Fill(Brush, PathBuilder)

DrawingCanvas.FillEllipse(Brush, PointF, SizeF)

DrawingCanvas.FillArc(Brush, PointF, SizeF, float, float, float)

DrawingCanvas.FillPie(Brush, PointF, SizeF, float, float, float)

DrawingCanvas.FillPie(Brush, PointF, SizeF, float, float)

DrawingCanvas.DrawArc(Pen, PointF, SizeF, float, float, float)

DrawingCanvas.DrawBezier(Pen, params PointF[])

DrawingCanvas.DrawEllipse(Pen, PointF, SizeF)

DrawingCanvas.DrawPie(Pen, PointF, SizeF, float, float, float)

DrawingCanvas.DrawPie(Pen, PointF, SizeF, float, float)

DrawingCanvas.Draw(Pen, Rectangle)

DrawingCanvas.Draw(Pen, IPathCollection)

DrawingCanvas.Draw(Pen, PathBuilder)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DrawingCanvas(Configuration, DrawingOptions, ICanvasFrame<TPixel>, params IPath[])

Initializes a new instance of the DrawingCanvas<TPixel> class.

public DrawingCanvas(Configuration configuration, DrawingOptions options, ICanvasFrame<TPixel> targetFrame, params IPath[] clipPaths)

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

targetFrame ICanvasFrame<TPixel>

The destination frame.

clipPaths IPath[]

Initial clip paths for this canvas instance.

DrawingCanvas(Configuration, DrawingOptions, IDrawingBackend, ICanvasFrame<TPixel>, params IPath[])

Initializes a new instance of the DrawingCanvas<TPixel> class with an explicit backend and initial state.

public DrawingCanvas(Configuration configuration, DrawingOptions options, IDrawingBackend backend, ICanvasFrame<TPixel> targetFrame, params IPath[] clipPaths)

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

backend IDrawingBackend

The drawing backend implementation.

targetFrame ICanvasFrame<TPixel>

The destination frame.

clipPaths IPath[]

Initial clip paths for this canvas instance.

DrawingCanvas(Configuration, DrawingOptions, Buffer2DRegion<TPixel>, params IPath[])

Initializes a new instance of the DrawingCanvas<TPixel> class.

public DrawingCanvas(Configuration configuration, DrawingOptions options, Buffer2DRegion<TPixel> targetRegion, params IPath[] clipPaths)

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

targetRegion Buffer2DRegion<TPixel>

The destination target region.

clipPaths IPath[]

Initial clip paths for this canvas instance.

Properties

Bounds

Gets the local bounds of this canvas.

public override Rectangle Bounds { get; }

Property Value

Rectangle

SaveCount

Gets the number of saved states currently on the canvas stack.

public override int SaveCount { get; }

Property Value

int

Methods

Apply(IPath, Action<IImageProcessingContext>)

Applies an image-processing operation to a path region.

public override void Apply(IPath path, Action<IImageProcessingContext> operation)

Parameters

path IPath

The path region to process.

operation Action<IImageProcessingContext>

The image-processing operation to apply to the region.

Remarks

The operation affects only pixels covered by the supplied path.

Apply(PathBuilder, Action<IImageProcessingContext>)

Applies an image-processing operation to a region described by a path builder.

public override void Apply(PathBuilder pathBuilder, Action<IImageProcessingContext> operation)

Parameters

pathBuilder PathBuilder

The path builder describing the region to process.

operation Action<IImageProcessingContext>

The image-processing operation to apply to the region.

Apply(Rectangle, Action<IImageProcessingContext>)

Applies an image-processing operation to a local region.

public override void Apply(Rectangle region, Action<IImageProcessingContext> operation)

Parameters

region Rectangle

The local region to process.

operation Action<IImageProcessingContext>

The image-processing operation to apply to the region.

Clear(Brush, IPath)

Clears a path region using the given brush and clear-style composition options.

public override void Clear(Brush brush, IPath path)

Parameters

brush Brush

Brush used to shade destination pixels during clear.

path IPath

The path region to clear.

CreateRegion(Rectangle)

Creates a child canvas over a subregion in local coordinates.

public override DrawingCanvas<TPixel> CreateRegion(Rectangle region)

Parameters

region Rectangle

The child region in local coordinates.

Returns

DrawingCanvas<TPixel>

A child canvas with local origin at (0,0).

CreateScene()

Creates a retained backend scene from the drawing commands currently queued on this canvas.

public override DrawingBackendScene CreateScene()

Returns

DrawingBackendScene

A retained backend scene.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public override void Dispose()

Draw(Pen, IPath)

Draws a path outline in local coordinates using the given pen.

public override void Draw(Pen pen, IPath path)

Parameters

pen Pen

Pen used to generate the outline fill path.

path IPath

The path to stroke.

DrawGlyphs(Brush, Pen, IEnumerable<GlyphPathCollection>)

Draws layered glyph geometry.

public override void DrawGlyphs(Brush brush, Pen pen, IEnumerable<GlyphPathCollection> glyphs)

Parameters

brush Brush

Brush used to fill glyph layers.

pen Pen

Pen used to outline dominant painted layers.

glyphs IEnumerable<GlyphPathCollection>

Layered glyph geometry to draw.

DrawImage(Image, Rectangle, RectangleF, IResampler?)

Draws an image source region into a destination rectangle.

public override void DrawImage(Image image, Rectangle sourceRect, RectangleF destinationRect, IResampler? sampler)

Parameters

image Image

The source image.

sourceRect Rectangle

The source rectangle within image.

destinationRect RectangleF

The destination rectangle in local canvas coordinates.

sampler IResampler

Optional resampler used when scaling or transforming the image. Defaults to Bicubic.

DrawImage(Image<TPixel>, Rectangle, RectangleF, IResampler?)

Draws an image source region into a destination rectangle.

public void DrawImage(Image<TPixel> image, Rectangle sourceRect, RectangleF destinationRect, IResampler? sampler = null)

Parameters

image Image<TPixel>

The source image.

sourceRect Rectangle

The source rectangle within image.

destinationRect RectangleF

The destination rectangle in local canvas coordinates.

sampler IResampler

Optional resampler used when scaling or transforming the image. Defaults to Bicubic.

DrawLine(Pen, PointF, PointF)

Draws a two-point line segment using the provided pen and drawing options.

public void DrawLine(Pen pen, PointF start, PointF end)

Parameters

pen Pen

Pen used to generate the line outline.

start PointF

Line start point.

end PointF

Line end point.

DrawLine(Pen, params PointF[])

Draws a polyline outline using the provided pen and drawing options.

public override void DrawLine(Pen pen, params PointF[] points)

Parameters

pen Pen

Pen used to generate the line outline.

points PointF[]

Polyline points.

DrawText(LineLayout, IPath, Brush?, Pen?)

Draws one prepared line layout along a path baseline onto this canvas.

public override void DrawText(LineLayout lineLayout, IPath path, Brush? brush, Pen? pen)

Parameters

lineLayout LineLayout

The prepared line layout to draw.

path IPath

The path used as the text baseline in local canvas coordinates.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

DrawText(LineLayout, PointF, Brush?, Pen?)

Draws one prepared line layout onto this canvas.

public override void DrawText(LineLayout lineLayout, PointF location, Brush? brush, Pen? pen)

Parameters

lineLayout LineLayout

The prepared line layout to draw.

location PointF

The drawing location in local canvas coordinates.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

DrawText(TextBlock, IPath, float, Brush?, Pen?)

Draws a prepared text block along a path baseline onto this canvas.

public override void DrawText(TextBlock textBlock, IPath path, float wrappingLength, Brush? brush, Pen? pen)

Parameters

textBlock TextBlock

The prepared text block to draw.

path IPath

The path used as the text baseline in local canvas coordinates.

wrappingLength float

The wrapping length in pixels. Use -1 to disable wrapping.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

DrawText(TextBlock, PointF, float, Brush?, Pen?)

Draws a prepared text block onto this canvas.

public override void DrawText(TextBlock textBlock, PointF location, float wrappingLength, Brush? brush, Pen? pen)

Parameters

textBlock TextBlock

The prepared text block to draw.

location PointF

The drawing location in local canvas coordinates.

wrappingLength float

The wrapping length in pixels. Use -1 to disable wrapping.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

DrawText(RichTextOptions, ReadOnlySpan<char>, IPath, Brush?, Pen?)

Draws text along a path baseline onto this canvas.

public override void DrawText(RichTextOptions textOptions, ReadOnlySpan<char> text, IPath path, Brush? brush, Pen? pen)

Parameters

textOptions RichTextOptions

The text rendering options.

text ReadOnlySpan<char>

The text to draw.

path IPath

The path used as the text baseline in local canvas coordinates.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

DrawText(RichTextOptions, ReadOnlySpan<char>, Brush?, Pen?)

Draws text onto this canvas.

public override void DrawText(RichTextOptions textOptions, ReadOnlySpan<char> text, Brush? brush, Pen? pen)

Parameters

textOptions RichTextOptions

The text rendering options.

text ReadOnlySpan<char>

The text to draw.

brush Brush

Optional brush used to fill glyphs.

pen Pen

Optional pen used to outline glyphs.

Fill(Brush, IPath)

Fills a path in local coordinates using the given brush.

public override void Fill(Brush brush, IPath path)

Parameters

brush Brush

Brush used to shade covered pixels.

path IPath

The path to fill.

Flush()

Seals queued drawing commands into the canvas timeline.

public override void Flush()

MeasureText(RichTextOptions, ReadOnlySpan<char>)

Measures the full set of layout metrics for the supplied text.

public override TextMetrics MeasureText(RichTextOptions textOptions, ReadOnlySpan<char> text)

Parameters

textOptions RichTextOptions

The text shaping and layout options.

text ReadOnlySpan<char>

The text to measure.

Returns

TextMetrics

A TextMetrics value containing the metrics for the laid-out text.

RenderScene(DrawingBackendScene)

Renders a retained backend scene into this canvas target.

public override void RenderScene(DrawingBackendScene scene)

Parameters

scene DrawingBackendScene

The retained backend scene to render.

Restore()

Restores the most recently saved state.

public override void Restore()

Remarks

If the most recently saved state was created by a SaveLayer overload, the layer is closed in the recorded timeline. Actual composition happens during Dispose().

RestoreTo(int)

Restores to a specific save count.

public override void RestoreTo(int saveCount)

Parameters

saveCount int

The save count to restore to.

Remarks

State frames above saveCount are discarded, and the last discarded frame becomes the current state. If any discarded state was created by a SaveLayer overload, those layers are closed in the recorded timeline and composed during Dispose().

Save()

Saves the current drawing state on the state stack.

public override int Save()

Returns

int

The save count after the state has been pushed.

Remarks

This operation stores the current canvas state by reference. If the same DrawingOptions instance is mutated after Save(), those mutations are visible when restoring.

Save(DrawingOptions, params IPath[])

Saves the current drawing state and replaces the active state with the provided options and clip paths.

public override int Save(DrawingOptions options, params IPath[] clipPaths)

Parameters

options DrawingOptions

Drawing options for the new active state.

clipPaths IPath[]

Clip paths for the new active state.

Returns

int

The save count after the previous state has been pushed.

Remarks

The provided options instance is stored by reference. Mutating it after this call mutates the active/restored state behavior.

SaveLayer(GraphicsOptions, Rectangle)

Saves the current drawing state and begins an isolated compositing layer bounded to a subregion. Subsequent draw commands are recorded into that isolated logical layer. When Restore() closes the layer, it is recorded into the canvas timeline and later composed during Dispose() using the specified layerOptions.

public override int SaveLayer(GraphicsOptions layerOptions, Rectangle bounds)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas when the canvas timeline is rendered during Dispose().

bounds Rectangle

The local bounds of the layer. Only this region is allocated and composited.

Returns

int

The save count after the layer state has been pushed.

Remarks

The layer bounds are expressed in the current local coordinate system and are transformed with the active drawing transform when the layer is created. They limit allocation and compositing only; they do not change the canvas coordinate system used by commands recorded inside the layer.