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, DrawingTextCache, ICanvasFrame<TPixel>, params IPath[])

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

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

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

textCache DrawingTextCache

The text drawing cache used by this canvas instance.

targetFrame ICanvasFrame<TPixel>

The destination frame.

clipPaths IPath[]

Initial clip paths for this canvas instance.

DrawingCanvas(Configuration, DrawingOptions, DrawingTextCache, 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, DrawingTextCache textCache, IDrawingBackend backend, ICanvasFrame<TPixel> targetFrame, params IPath[] clipPaths)

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

textCache DrawingTextCache

The text drawing cache used by 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, DrawingTextCache, Buffer2DRegion<TPixel>, params IPath[])

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

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

Parameters

configuration Configuration

The active processing configuration.

options DrawingOptions

Initial drawing options for this canvas instance.

textCache DrawingTextCache

The text drawing cache used by this canvas instance.

targetRegion Buffer2DRegion<TPixel>

The destination target region.

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(IPath, Action<IImageProcessingContext>, GraphicsOptions, Point)

Applies an image-processing operation to a path region and composites the processed pixels back with explicit options, optionally offset from where they were read.

public override void Apply(IPath path, Action<IImageProcessingContext> operation, GraphicsOptions writeBackOptions, Point writeBackOffset)

Parameters

path IPath

The path region to process.

operation Action<IImageProcessingContext>

The image-processing operation to apply to the region.

writeBackOptions GraphicsOptions

The graphics options used to composite the processed pixels back.

writeBackOffset Point

The offset at which the processed pixels are written back.

Remarks

The write-back affects only pixels covered by the supplied path translated by the offset.

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.

Apply(Rectangle, Action<IImageProcessingContext>, GraphicsOptions, Point)

Applies an image-processing operation to a local region and composites the processed pixels back with explicit options, optionally offset from where they were read. The target region is untouched while the operation runs, so the processed pixels can be blended against the original content; for example a drop shadow composites the tinted, blurred region back beneath the content with DestOver at the shadow offset.

public override void Apply(Rectangle region, Action<IImageProcessingContext> operation, GraphicsOptions writeBackOptions, Point writeBackOffset)

Parameters

region Rectangle

The local region to process.

operation Action<IImageProcessingContext>

The image-processing operation to apply to the region.

writeBackOptions GraphicsOptions

The graphics options used to composite the processed pixels back.

writeBackOffset Point

The offset at which the processed pixels are written back.

Clear(Brush, IPath)

Fills a path region with the given brush using replacement composition: the brush output overwrites the covered pixels outright, including their alpha, rather than blending over them.

public override void Clear(Brush brush, IPath path)

Parameters

brush Brush

Brush used to shade destination pixels during the clear.

path IPath

The path region to clear.

Clip(ClipOperation, params IPath[])

Narrows the current clip region by applying the specified clipping operation with the supplied clip paths.

public override void Clip(ClipOperation operation, params IPath[] clipPaths)

Parameters

operation ClipOperation

The operation to apply to the current clip.

clipPaths IPath[]

The clip paths to combine with the current clip, in local coordinates.

Remarks

The clip paths are transformed by the active transform at the point this is called.

Clip(params IPath[])

Narrows the current clip region by intersecting it with the supplied clip paths.

public override void Clip(params IPath[] clipPaths)

Parameters

clipPaths IPath[]

The clip paths to intersect with the current clip, in local coordinates.

Remarks

The clip paths are transformed by the active transform at the point this is called, then intersected with the existing clip; clipping only ever narrows. The resulting clip is part of the current saved state and is restored by Restore(). Multiple paths combine as a union before intersecting (e.g. a region built from several rectangles).

CopyPixelsFrom(DrawingCanvas, Rectangle, Point)

Copies pixels from another canvas into this canvas.

public override void CopyPixelsFrom(DrawingCanvas source, Rectangle sourceRectangle, Point targetPoint)

Parameters

source DrawingCanvas

The source canvas.

sourceRectangle Rectangle

The source rectangle in source-local coordinates.

targetPoint Point

The target point in this canvas' local coordinates.

Remarks

Any queued commands on both canvases are applied before the copy.

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()

Seals the commands recorded so far into a retained backend scene and clears them from the canvas queue.

public override DrawingBackendScene CreateScene()

Returns

DrawingBackendScene

The created backend scene.

Remarks

The active clip range is closed before the scene is built and reopened afterwards, so this acts as an ordering boundary in the recorded timeline. Image resources retained for the sealed commands are transferred to the returned scene, which owns and disposes them.

Dispose()

Releases the canvas. Disposing the root canvas closes any open layers and clips and replays the recorded command timeline into the target frame; child region canvases share the root's command stream and do not flush on disposal.

public override void Dispose()

Remarks

The root canvas also releases image resources retained for deferred draws and, when it owns the text drawing cache, clears that cache. Disposal is idempotent.

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, WrapMode, WrapMode, IResampler?)

Draws an image source region into a destination rectangle, tiling the painted area by repeating the destination rectangle outwards per the supplied WrapModes.

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

Parameters

image Image

The source image.

sourceRect Rectangle

The source rectangle within image.

destinationRect RectangleF

The destination rectangle in local canvas coordinates (defines a single tile cell).

wrapX WrapMode

The horizontal wrap mode applied when sampling beyond destinationRect.

wrapY WrapMode

The vertical wrap mode applied when sampling beyond destinationRect.

sampler IResampler

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

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, WrapMode, WrapMode, IResampler?)

Draws an image source region into a destination rectangle, tiling the painted area by repeating the destination rectangle outwards per the supplied WrapModes.

public void DrawImage(Image<TPixel> image, Rectangle sourceRect, RectangleF destinationRect, WrapMode wrapX, WrapMode wrapY, 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 (defines a single tile cell).

wrapX WrapMode

The horizontal wrap mode applied when sampling beyond destinationRect.

wrapY WrapMode

The vertical wrap mode applied when sampling beyond destinationRect.

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.

DrawText(ReadOnlySpan<ushort>, ReadOnlySpan<Vector2>, RichGlyphOptions, Brush?, Pen?)

Draws positioned glyphs onto this canvas.

public override void DrawText(ReadOnlySpan<ushort> glyphIds, ReadOnlySpan<Vector2> points, RichGlyphOptions options, Brush? brush, Pen? pen)

Parameters

glyphIds ReadOnlySpan<ushort>

The glyph identifiers.

points ReadOnlySpan<Vector2>

The absolute glyph origins in pixel units.

options RichGlyphOptions

The glyph rendering options, including the font and optional glyph paint.

brush Brush

Default brush used to fill glyphs when Brush is not set.

pen Pen

Default pen used to outline glyphs when Pen is not set.

DrawText(ushort, RichGlyphOptions, Brush?, Pen?)

Draws a single glyph, identified by its glyph id, onto this canvas.

public override void DrawText(ushort glyphId, RichGlyphOptions options, Brush? brush, Pen? pen)

Parameters

glyphId ushort

The id of the glyph within the font face referenced by options.

options RichGlyphOptions

The glyph rendering options, including the font, origin, grapheme index and optional per-glyph paint.

brush Brush

Default brush used to fill the glyph when Brush is not set.

pen Pen

Default pen used to outline the glyph when Pen is not set.

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 the drawing commands recorded so far into an ordered range so that subsequent commands begin a new range.

public override void Flush()

Remarks

This does not rasterize or composite anything into the target frame. Recorded commands are replayed into the target only when the root canvas is disposed, or when they are lowered explicitly through CreateScene(), RenderScene(DrawingBackendScene) or CopyPixelsFrom(DrawingCanvas, Rectangle, Point). Use this to establish an ordering boundary in the recorded timeline without ending the canvas.

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)

Records a previously created backend scene into this canvas' command timeline.

public override void RenderScene(DrawingBackendScene scene)

Parameters

scene DrawingBackendScene

The backend scene to render.

Remarks

The active command range is sealed before the scene is inserted so the scene renders in submission order relative to the commands recorded around it. Like other recorded work, the scene is replayed into the target frame when the root canvas is disposed or otherwise flushed, not at the point of this call.

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 and becomes part of subsequent rendering.

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 and become part of subsequent rendering.

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)

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

public override int Save(DrawingOptions options)

Parameters

options DrawingOptions

Drawing options 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, IPath, LayerEffect)

Saves the current drawing state and begins an isolated compositing layer whose content is transformed by an effect confined to a path region when the layer is restored.

public override int SaveLayer(GraphicsOptions layerOptions, IPath region, LayerEffect effect)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

region IPath

The path region the effect processes, in local coordinates.

effect LayerEffect

The effect applied to the layer content on restore.

Returns

int

The save count after the layer state has been pushed.

Remarks

The effect processes only pixels covered by the supplied path; its output lands on the path translated by the effect's offset. The layer bounds are derived from the path and expanded by the effect's reach.

SaveLayer(GraphicsOptions, IPath, LayerEffect, DrawingOptions)

Saves the current drawing state and begins an isolated compositing layer whose content is transformed by an effect confined to a path region when the layer is restored, using the supplied drawing options for commands recorded into the layer.

public override int SaveLayer(GraphicsOptions layerOptions, IPath region, LayerEffect effect, DrawingOptions options)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

region IPath

The path region the effect processes, in local coordinates.

effect LayerEffect

The effect applied to the layer content on restore.

options DrawingOptions

Drawing options for the layer contents.

Returns

int

The save count after the layer state has been pushed.

SaveLayer(GraphicsOptions, Rectangle)

Saves the current drawing state and begins an isolated compositing layer bounded to a subregion. Subsequent draw commands target that layer until Restore() closes it.

public override int SaveLayer(GraphicsOptions layerOptions, Rectangle bounds)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

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.

SaveLayer(GraphicsOptions, Rectangle, DrawingOptions)

Saves the current drawing state and begins an isolated compositing layer using the supplied drawing options for commands recorded into the layer.

public override int SaveLayer(GraphicsOptions layerOptions, Rectangle bounds, DrawingOptions options)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

bounds Rectangle

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

options DrawingOptions

Drawing options for the layer contents.

Returns

int

The save count after the layer state has been pushed.

SaveLayer(GraphicsOptions, Rectangle, LayerEffect)

Saves the current drawing state and begins an isolated compositing layer whose content is transformed by an effect when the layer is restored.

public override int SaveLayer(GraphicsOptions layerOptions, Rectangle bounds, LayerEffect effect)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

bounds Rectangle

The content bounds in local canvas coordinates.

effect LayerEffect

The effect applied to the layer content on restore.

Returns

int

The save count after the layer state has been pushed.

Remarks

The layer isolates the content, so the effect operates on exactly what is drawn between this call and the matching Restore(), against transparency; a DropShadowLayerEffect, for example, slots its shadow beneath that content before the layer composites onto the canvas. The bounds are expanded internally by the effect's reach so blurred or offset output is not cut off.

SaveLayer(GraphicsOptions, Rectangle, LayerEffect, DrawingOptions)

Saves the current drawing state and begins an isolated compositing layer whose content is transformed by an effect when the layer is restored, using the supplied drawing options for commands recorded into the layer.

public override int SaveLayer(GraphicsOptions layerOptions, Rectangle bounds, LayerEffect effect, DrawingOptions options)

Parameters

layerOptions GraphicsOptions

Graphics options controlling how the closed layer is composited against the parent canvas.

bounds Rectangle

The content bounds in local canvas coordinates.

effect LayerEffect

The effect applied to the layer content on restore.

options DrawingOptions

Drawing options for the layer contents.

Returns

int

The save count after the layer state has been pushed.