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

DrawStrings_Palette

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Draws strings (text) on an image with multiple colors.

Syntax

void avs::DrawStrings_Palette
(
	const avl::Image& inImage,
	const atl::Conditional<atl::Array<atl::Conditional<atl::String> > >& inStrings,
	const atl::Conditional<atl::Array<atl::Conditional<avl::Location> > >& inLocations,
	atl::Optional<const avl::CoordinateSystem2D&> inLocationAlignment,
	const avl::Anchor2D::Type inLocationAnchor,
	const atl::Optional<atl::Array<avl::Pixel> >& inColors,
	const avl::DrawingStyle& inDrawingStyle,
	float inSize,
	float inOrientationAngle,
	const bool inForceRgb,
	const atl::Optional<avl::Pixel>& inBackgroundColor,
	avl::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inStrings	const Conditional<Array<Conditional<String> > >&		{ }	String to draw
inLocations	const Conditional<Array<Conditional<Location> > >&		{ }	Center point of each string to draw
inLocationAlignment	Optional<const CoordinateSystem2D&>		NIL
inLocationAnchor	const Anchor2D::Type		MiddleCenter
inColors	const Optional<Array<Pixel> >&		NIL	Color for each string to be drawn
inDrawingStyle	const DrawingStyle&		DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
inSize	float	10.0 -	16.0f	Height of a character in pixels
inOrientationAngle	float		0.0f	Orientation of text in degrees
inForceRgb	const bool		True	Filter will convert monochromatic image to RGB if needed
inBackgroundColor	const Optional<Pixel>&		NIL	Color of pixels drawn on image in text row
outImage	Image&			Output image

Description

The operation draws a strings on the inImage aligning the inLocationAnchor location of the text at the inLocations of the inImage. The height of the font is fixed and equals 16 pixels.

Hints

If you want to draw on an empty background, use EmptyImage function before.
Define inStrings. This will be the primitives to be drawn.
For each of the strings also define its location by setting the inLocations input.
If the locations provided on the inLocations input are in a local coordinate system, also set the inLocationAlignment input.
Set inLocationAnchor do define how each of the strings should be aligned in relation to its location.
Define the font size by setting the inSize input. Recommended values are: 16, 32, 48, 64.
Leave the inColors input not set to have all the primitives drawn with random colors. Set a custom array of colors here to decide explicitly how each of the primitives should be drawn.
Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.
Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.

Examples