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

DrawBoxes_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
Module:	FoundationLite

Draws boxes on an image with a single color.

Syntax

void fis::DrawBoxes_SingleColor
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Box>>&> inBoxes,
	const fil::Pixel& inColor,
	const float inOpacity,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inBoxes	Conditional<const Array<Conditional<Box>>&>		{ }
inColor	const Pixel&
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

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Description

The operation draws an array of boxes on the inImage using common drawing parameters for all of them. Boxes may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed. Note that drawing is conducted in a pixel-precise way as the Box type is pixel-precise.

Hints

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

Example usage of the DrawBoxes_SingleColor on an empty image.