Back to Aurora Vision Library website

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

DrawShapeRegions_SingleColor


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 shape regions on an image with a single color.

Syntax

void avs::DrawShapeRegions_SingleColor
(
	const avl::Image& inImage,
	atl::Conditional<const atl::Array<atl::Conditional<avl::ShapeRegion>>&> inRois,
	atl::Optional<const avl::CoordinateSystem2D&> inRegionAlignment,
	const avl::Pixel& inColor,
	const avl::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inRois Conditional<const Array<Conditional<ShapeRegion>>&> { }
Input value inRegionAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColor const Pixel&
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
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 an array of shape regions on the inImage using common drawing parameters for all of them. Regions may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.

Hints

  • If you want to draw on an empty background, use EmptyImage function before.
  • Define inRois. This will be the primitives to be drawn.
  • Define inColor. Please note, that on an N-channel image only first N components of the color will be used.
  • Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.

Examples

Example usage of the DrawShapeRegions_SingleColor on an empty image.

See Also

  • DrawBox – Draws a box on an image.