Class DrawTextProcessor

Defines a processor to draw text on an Image.

Inheritance

object

DrawTextProcessor

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.Text

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public class DrawTextProcessor : IImageProcessor

Constructors

DrawTextProcessor(DrawingOptions, RichTextOptions, string, Brush?, Pen?)

Initializes a new instance of the DrawTextProcessor class.

Declaration

public DrawTextProcessor(DrawingOptions drawingOptions, RichTextOptions textOptions, string text, Brush? brush, Pen? pen)

Parameters

Type	Name	Description
DrawingOptions	drawingOptions	The drawing options.
RichTextOptions	textOptions	The text rendering options.
string	text	The text we want to render
Brush	brush	The brush to source pixel colors from.
Pen	pen	The pen to outline text with.

Properties

Brush

Gets the brush used to fill the glyphs.

Declaration

public Brush? Brush { get; }

Property Value

Type	Description
Brush

DrawingOptions

Gets the DrawingOptions defining blending modes and shape drawing settings.

Declaration

public DrawingOptions DrawingOptions { get; }

Property Value

Type	Description
DrawingOptions

Location

Gets the location to draw the text at.

Declaration

public PointF Location { get; }

Property Value

Type	Description
PointF

Pen

Gets the pen used for outlining the text, if Null then we will not outline

Declaration

public Pen? Pen { get; }

Property Value

Type	Description
Pen

Text

Gets the text to draw.

Declaration

public string Text { get; }

Property Value

Type	Description
string

TextOptions

Gets the RichTextOptions defining text-specific drawing settings.

Declaration

public RichTextOptions TextOptions { get; }

Property Value

Type	Description
RichTextOptions

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