Class DrawTextProcessor

Defines a processor to draw text on an .

Inheritance
Object
DrawTextProcessor
Namespace: SixLabors.ImageSharp.Drawing.Processing.Processors.Text
Assembly: SixLabors.ImageSharp.Drawing.dll
Syntax
public class DrawTextProcessor : IImageProcessor

Constructors

| Improve this Doc View Source

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

| Improve this Doc View Source

Brush

Gets the brush used to fill the glyphs.

Declaration
public Brush Brush { get; }
Property Value
Type Description
Brush
| Improve this Doc View Source

DrawingOptions

Gets the DrawingOptions defining blending modes and shape drawing settings.

Declaration
public DrawingOptions DrawingOptions { get; }
Property Value
Type Description
DrawingOptions
| Improve this Doc View Source

Location

Gets the location to draw the text at.

Declaration
public PointF Location { get; }
Property Value
Type Description
PointF
| Improve this Doc View Source

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
| Improve this Doc View Source

Text

Gets the text to draw.

Declaration
public string Text { get; }
Property Value
Type Description
String
| Improve this Doc View Source

TextOptions

Gets the RichTextOptions defining text-specific drawing settings.

Declaration
public RichTextOptions TextOptions { get; }
Property Value
Type Description
RichTextOptions

Methods

| Improve this Doc View Source

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

Declaration
public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuration configuration, Image<TPixel> source, Rectangle sourceRectangle)
    where TPixel : struct, IPixel<TPixel>
Parameters
Type Name Description
Configuration configuration
Image<TPixel> source
Rectangle sourceRectangle
Returns
Type Description
IImageProcessor<TPixel>
Type Parameters
Name Description
TPixel