Back to Aurora Vision Library website

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

DrawStrings_MultiColor


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

Header: AVL.h
Namespace: avs
Module: FoundationLite

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

Syntax

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

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inStrings Conditional< const Array<Conditional<String>> &> { } String to draw
Input value inLocations Conditional< const Array<Conditional<Location>> &> { } Center point of each string to draw
Input value inLocationAlignment Optional<const CoordinateSystem2D&> NIL
Input value inLocationAnchor const Anchor2D::Type MiddleCenter
Input value inColorIds Optional<const Array<Conditional<Hash>>&> NIL
Input value 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 ) }
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.

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 inPalette and inColorIds 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 using inColorIds.
  • 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

Example usage of the DrawStrings_MultiColor on an empty image.

Errors

List of possible exceptions:

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

See Also

  • DrawLine – Draws a line on an image.
  • DrawPath – Draws a path on an image.