Back to Adaptive Vision Library website

You are here: Start » Function Reference » Image Drawing » DrawString

DrawString


Header:AVL.h
Namespace:avl

Draws a string on an image.

Syntax

C++
C#
 
void avl::DrawString
(
	avl::Image& ioImage,
	const atl::String& inString,
	const avl::Location& inLocation,
	atl::Optional<const avl::CoordinateSystem2D&> inLocationAlignment,
	const avl::Anchor2D::Type inLocationAnchor,
	const avl::Pixel& inColor,
	const avl::DrawingStyle& inDrawingStyle,
	float inSize,
	float inOrientationAngle,
	atl::Optional<const avl::Pixel&> inBackgroundColor
)

Parameters

Name Type Default Description
ioImage Image&
inString const String&
inLocation const Location&
inLocationAlignment Optional<const CoordinateSystem2D&> NIL
inLocationAnchor const Anchor2D::Type MiddleCenter
inColor const Pixel&
inDrawingStyle const DrawingStyle&
inSize float 12.0f Height of a character
inOrientationAngle float 0.0f
inBackgroundColor Optional<const Pixel&> NIL

Description

The operation draws a string on the ioImage aligning the inLocationAnchor location of the text at the inLocation of the ioImage. The height of the font is fixed and equals 16 pixels.

Usage of DrawString with various settings.

See Also

  • DrawLine – Draws a line on an image.
  • DrawPath – Draws a path on an image.