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

DrawCircles_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 circles on an image with a single color.

Syntax

void fis::DrawCircles_SingleColor
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Circle2D>>&> inCircles,
	ftl::Optional<const fil::CoordinateSystem2D&> inCircleAlignment,
	const fil::Pixel& inColor,
	const fil::DrawingStyle& inDrawingStyle,
	bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inCircles	Conditional<const Array<Conditional<Circle2D>>&>	{ }
inCircleAlignment	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	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 circles on the inImage using common drawing parameters for all of them. Circles may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.

Hints

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

Examples

Example usage of the DrawCircles_SingleColor on an empty image.