You are here: Start » Function Reference » All Functions » Image Drawing » DrawStringLabels_MultiColor

DrawStringLabels_MultiColor

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 multiple colors.

Syntax

void fis::DrawStringLabels_MultiColor
(
	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,
	ftl::Optional<const ftl::Array<ftl::Conditional<fil::Hash>>&> inColorIds,
	ftl::Optional<const ftl::Array<fil::Pixel>&> inPalette,
	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
inImage	const Image&			Input image
inLabels	Conditional<const Array<Conditional<StringLabel>>&>		{ }	String to draw
inLocationAlignment	Optional<const CoordinateSystem2D&>		NIL
inLocationAnchor	const Anchor2D::Type		MiddleCenter
inColorIds	Optional<const Array<Conditional<Hash>>&>		NIL
inPalette	Optional<const Array<Pixel>&>		{ Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f ), Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f ) }
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	Optional<const Pixel&>		NIL	Color of pixels drawn on image in text row
outImage	Image&			Output image

In-place Processing

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty inPalette while inLabels has objects to draw in DrawStringLabels_MultiColor.
DomainError	No palette defined with inPalette for specified inColorIds in DrawStringLabels_MultiColor.
DomainError	The sizes inLabels and inColorIds do not match in DrawStringLabels_MultiColor.