DrawString


Draws a string on an image.

Syntax

C++
Python
 
def DrawString(
	ioImage: Image,
	inString: str,
	inLocation: Location,
	inColor: Pixel,
	/,
	*,
	inLocationAlignment: CoordinateSystem2D | None = None,
	inLocationAnchor: Anchor2D = Anchor2D.MiddleCenter,
	inDrawingStyle: DrawingStyle = DrawingStyle(DrawingMode.HighQuality, 1.0, 3.0, False, None, 2.0),
	inSize: float = 12.0,
	inOrientationAngle: float = 0.0,
	inBackgroundColor: Pixel | None = None
)
-> None

Parameters

Name Type Default Description
Input will be modified ioImage Image
Input value inString str
Input value inLocation Location
Input value inLocationAlignment CoordinateSystem2D | None None
Input value inLocationAnchor Anchor2D Anchor2D.MiddleCenter
Input value inColor Pixel
Input value inDrawingStyle DrawingStyle DrawingStyle(DrawingMode.HighQuality, 1.0, 3.0, False, None, 2.0)
Input value inSize float 12.0 Height of a character
Input value inOrientationAngle float 0.0
Input value inBackgroundColor Pixel | None None