Back to FabImage Library Lite website

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

DrawString


Header: FIL.h
Namespace: fil

Draws a string on an image.

Syntax

void fil::DrawString
(
	fil::Image& ioImage,
	const ftl::String& inString,
	const fil::Location& inLocation,
	ftl::Optional<const fil::CoordinateSystem2D&> inLocationAlignment,
	const fil::Anchor2D::Type inLocationAnchor,
	const fil::Pixel& inColor,
	const fil::DrawingStyle& inDrawingStyle,
	float inSize,
	float inOrientationAngle,
	ftl::Optional<const fil::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.