Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Image » Image Drawing » DrawRegions_SingleColor


Module: FoundationLite

Draws regions on an image with a single color.

Name Type Range Description
Input value
inImage Image Input image
Input value
inRegions Region?Array?
Input value
inRegionAlignment CoordinateSystem2D*
Input value
inColor Pixel
Input value
inOpacity Real 0.0 - 1.0
Input value
inForceRgb Bool Filter will convert monochromatic image to RGB if needed
Output value
outImage Image Output image


The operation draws an array of 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.


  • Connect an image source to the inImage input. Drawing will be done on this image.
  • If you want to draw on an empty background, use EmptyImage filter before.
  • Define inRegions. 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.


Description of usage of this filter can be found in examples and tutorial: Brick destroy (Game), Comparing Golden Template, Extracting Capsule Shape.

Example usage of the DrawRegions_SingleColor on an empty image.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of DrawRegions filter group.

See Also