Back to Aurora Vision Studio website
You are here: Start » Filter Reference » Image » Image Drawing » DrawRegions_MultiColor
Module: | FoundationLite |
---|
Draws regions on an image with multiple colors.
Name | Type | Range | Description | |
---|---|---|---|---|
inImage | Image | Input image | ||
inRegions | Region?Array? | |||
inRegionAlignment | CoordinateSystem2D* | |||
inColorIds | Hash?Array* | |||
inPalette | PixelArray* | |||
inOpacity | Real | 0.0 - 1.0 | ||
inForceRgb | Bool | Filter will convert monochromatic image to RGB if needed | ||
outImage | Image | Output image |
Description
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.
Hints
- 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.
- Leave 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.
Examples
Description of usage of this filter can be found in examples and tutorial: Brick destroy (Game).
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty inPalette while inRegions has objects to draw in DrawRegions_MultiColor. |
DomainError | No palette defined with inPalette for specified inColorIds in DrawRegions_MultiColor. |
DomainError | The sizes inRegions and inColorIds do not match in DrawRegions_MultiColor. |
Complexity Level
This filter is available on Advanced Complexity Level.
Filter Group
This filter is member of DrawRegions filter group.