Back to FabImage Library website

You are here: Start » Function Reference » All Functions » 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.

Header: FIL.h
Namespace: fis
Module: FoundationLite

Draws strings (text) on an image with two colors, depending on the status of each string.

Applications: Usually: green or red for pass/fail status.

Syntax

void fis::DrawStringLabels_TwoColors
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::StringLabel>>&> inLabels,
	ftl::Optional<const fil::CoordinateSystem2D&> inLocationAlignment,
	const fil::Anchor2D::Type inLocationAnchor,
	const fil::Pixel& inColorIfTrue,
	const fil::Pixel& inColorIfFalse,
	ftl::Conditional<const ftl::Array<ftl::Conditional<bool>> &> inConditions,
	const fil::DrawingStyle& inDrawingStyle,
	float inSize,
	float inOrientationAngle,
	const bool inForceRgb,
	ftl::Optional<const fil::Pixel&> inBackgroundColor,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value
 inImage const Image& Input image
Input value
 inLabels Conditional<const Array<Conditional<StringLabel>>&> { }
Input value
 inLocationAlignment Optional<const CoordinateSystem2D&> NIL
Input value
 inLocationAnchor const Anchor2D::Type MiddleCenter
Input value
 inColorIfTrue const Pixel& Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f ) Color corresponding to True value on inCondition input
Input value
 inColorIfFalse const Pixel& Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f ) Color corresponding to False value on inCondition input
Input value
 inConditions Conditional<const Array<Conditional<bool>> &> { }
Input value
 inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value
 inSize float 10.0 - 16.0f Height of a character in pixels
Input value
 inOrientationAngle float 0.0f Orientation of text in degrees
Input value
 inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Input value
 inBackgroundColor Optional<const Pixel&> NIL Color of pixels drawn on image in text row
Output value
 outImage Image& Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Read more about In-place Computation.

Errors

List of possible exceptions:

Error type Description
DomainError The sizes inLabels and inConditions do not match in DrawStringLabels_TwoColors.