You are here: Start » Image Drawing » DrawShapeRegions_Palette

DrawShapeRegions_Palette

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

Draws ShapeRegion objects on an image with multiple colors.

Syntax

void fis::DrawShapeRegions_Palette
(
	const fil::Image& inImage,
	const ftl::Conditional<ftl::Array<ftl::Conditional<fil::ShapeRegion> > >& inShapeRegions,
	ftl::Optional<const fil::CoordinateSystem2D&> inShapeRegionAlignment,
	const ftl::Optional<ftl::Array<fil::Pixel> >& inColors,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inShapeRegions	const Conditional<Array<Conditional<ShapeRegion> > >&	{ }
inShapeRegionAlignment	Optional<const CoordinateSystem2D&>	NIL
inColors	const Optional<Array<Pixel> >&	NIL
inDrawingStyle	const DrawingStyle&
inForceRgb	const bool	True	Filter will convert monochromatic image to RGB if needed
outImage	Image&		Output image

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

Example usage of the DrawShapeRegions_Palette on an empty image.