You are here: Start » Image Drawing » DrawRegions_Palette

DrawRegions_Palette

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

Draws regions on an image with multiple colors.

Syntax

void fis::DrawRegions_Palette
(
	const fil::Image& inImage,
	const ftl::Conditional<ftl::Array<ftl::Conditional<fil::Region> > >& inRegions,
	ftl::Optional<const fil::CoordinateSystem2D&> inRegionAlignment,
	const ftl::Optional<ftl::Array<fil::Pixel> >& inColors,
	const float inOpacity,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRegions	const Conditional<Array<Conditional<Region> > >&		{ }
inRegionAlignment	Optional<const CoordinateSystem2D&>		NIL
inColors	const Optional<Array<Pixel> >&		NIL
inOpacity	const float	0.0 - 1.0	1.0f
inForceRgb	const bool		True	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

If you want to draw on an empty background, use EmptyImage function before.
Define inRegions 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