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

DrawStringLabels_TwoColors

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 two colors, depending on the status of each string (usually: green or red for pass/fail status).

Syntax

void avs::DrawStringLabels_TwoColors
(
	const avl::Image& inImage,
	const atl::Conditional<atl::Array<atl::Conditional<avl::StringLabel> > >& inLabels,
	atl::Optional<const avl::CoordinateSystem2D&> inLocationAlignment,
	const avl::Anchor2D::Type inLocationAnchor,
	const avl::Pixel& inColorIfTrue,
	const avl::Pixel& inColorIfFalse,
	const atl::Conditional< atl::Array<atl::Conditional<bool> > >& inConditions,
	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
	inLabels	const Conditional<Array<Conditional<StringLabel> > >&		{ }
	inLocationAlignment	Optional<const CoordinateSystem2D&>		NIL
	inLocationAnchor	const Anchor2D::Type		MiddleCenter
	inColorIfTrue	const Pixel&		Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f )	Color corresponding to True value on inCondition input
	inColorIfFalse	const Pixel&		Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f )	Color corresponding to False value on inCondition input
	inConditions	const Conditional< Array<Conditional<bool> > >&		{ }
	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