You are here: Start » Function Reference » All Functions » Image Drawing » DrawShapeRegions_SingleColor_Deprecated

DrawShapeRegions_SingleColor_Deprecated

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

Header:	FIL.h
Namespace:	fis
Module:	FoundationLite

Draws ShapeRegion objects on an image with a single color.

Syntax

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

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inShapeRegions	Conditional<const Array<Conditional<ShapeRegionDeprecated> > &>	{ }
inShapeRegionAlignment	Optional<const CoordinateSystem2D&>	NIL
inColor	const Pixel&
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

Hints

Define inShapeRegions. 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.

Examples