You are here: Start » Function Reference » Image Drawing » DrawRectangles_SingleColor

DrawRectangles_SingleColor

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

Draws rectangles on an image with a single color.

Syntax

void fis::DrawRectangles_SingleColor
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Rectangle2D>>&> inRectangles,
	ftl::Optional<const fil::CoordinateSystem2D&> inRectangleAlignment,
	const fil::Pixel& inColor,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRectangles	Conditional<const Array<Conditional<Rectangle2D>>&>	{ }
inRectangleAlignment	Optional<const CoordinateSystem2D&>	NIL
inColor	const Pixel&
inDrawingStyle	const DrawingStyle&	DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
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

Description

Filter draws rectangles on an input image.

If an rectangle dimensions exceeds image size it will not be drawn or will be drawn partially.

Hints

Define inRectangles. 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.
Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.

Examples

Example usage of the DrawRectangles_SingleColor on an empty image.