Back to Aurora Vision Library website
You are here: Start » Function Reference » All Functions » Image Drawing » DrawShapeRegions_Palette_Deprecated
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 ShapeRegion objects on an image with multiple colors.
Syntax
void avs::DrawShapeRegions_Palette_Deprecated ( const avl::Image& inImage, atl::Conditional<const atl::Array<atl::Conditional<avl::ShapeRegionDeprecated> > &> inShapeRegions, atl::Optional<const avl::CoordinateSystem2D&> inShapeRegionAlignment, const atl::Optional<const atl::Array<avl::Pixel>&>& inColors, const avl::DrawingStyle& inDrawingStyle, const bool inForceRgb, avl::Image& outImage )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
![]() |
inImage | const Image& | Input image | |
![]() |
inShapeRegions | Conditional<const Array<Conditional<ShapeRegionDeprecated> > &> | { } | |
![]() |
inShapeRegionAlignment | Optional<const CoordinateSystem2D&> | NIL | |
![]() |
inColors | const Optional<const Array<Pixel>&>& | NIL | |
![]() |
inDrawingStyle | const DrawingStyle& | ||
![]() |
inForceRgb | const bool | True | Filter will convert monochromatic image to RGB if needed |
![]() |
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.
Hints
- Define inShapeRegions. This will be the primitives to be drawn.
- Leave the inColors input 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.
- Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.
Examples
![](../../img/filters/DrawShapeRegions_MultiColor.png)
Example usage of the DrawShapeRegions_Palette_Deprecated on an empty image.