Add-ImageText

Namespace ImagePlayground

Inputs

System.String

Adds text to an image at the provided coordinates and writes the updated image to disk.

Remarks

Adds text to an image at the provided coordinates and writes the updated image to disk.

Examples

Authored help example

Add watermark text


Add-ImageText -FilePath in.png -OutputPath out.png -Text "Sample" -X 10 -Y 10

Draw text using ImageSharp


using SixLabors.ImageSharp;
using SixLabors.ImageSharp.ColorSpaces;
using var img = Image.Load("in.png");
img.AddText(10, 10, "Sample", Color.Black, 24);
img.Save("out.png");

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Add-ImageText [-Color <Color>] -FilePath <String> [-FontFamily <String>] [-FontSize <Single>] [-OutlineColor <Color>] [-OutlineWidth <Single>] -OutputPath <String> [-ShadowColor <Color>] [-ShadowOffsetX <Single>] [-ShadowOffsetY <Single>] -Text <String> -X <Single> -Y <Single> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Color Color optionalposition: namedpipeline: False: Text color.
FilePath String requiredposition: 0pipeline: True (ByValue): Source image path.
FontFamily String optionalposition: namedpipeline: False: Font family.
FontSize Single optionalposition: namedpipeline: False: Font size.
OutlineColor Color optionalposition: namedpipeline: False: Outline color.
OutlineWidth Single optionalposition: namedpipeline: False: Outline width.
OutputPath String requiredposition: 1pipeline: False: Destination image path.
ShadowColor Color optionalposition: namedpipeline: False: Color of shadow.
ShadowOffsetX Single optionalposition: namedpipeline: False: X offset for shadow.
ShadowOffsetY Single optionalposition: namedpipeline: False: Y offset for shadow.
Text String requiredposition: 2pipeline: False: Text to add.
X Single requiredposition: 3pipeline: False: X coordinate.
Y Single requiredposition: 4pipeline: False: Y coordinate.