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

DrawBoxes_Palette

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 boxes on an image with multiple colors.

Syntax

void fis::DrawBoxes_Palette
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Box> > &> inBoxes,
	ftl::Optional<const 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
inBoxes	Conditional<const Array<Conditional<Box> > &>		{ }
inColors	Optional<const 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

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

Connect an image source to the inImage input. Drawing will be done on this image.
If you want to draw on an empty background, use EmptyImage function before.
Define inBoxes. 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 DrawBoxes_Palette on an empty image.