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

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

Syntax

void fis::DrawLines_Palette
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Line2D> >&> inLines,
	ftl::Optional<const fil::CoordinateSystem2D&> inLineAlignment,
	ftl::Optional<const ftl::Array<fil::Pixel>&> inColors,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inLines	Conditional<const Array<Conditional<Line2D> >&>	{ }
inLineAlignment	Optional<const CoordinateSystem2D&>	NIL
inColors	Optional<const Array<Pixel>&>	NIL
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

The operation draws an array of lines on the inImage using common drawing parameters for all of them. As the length of every line is infinite, they are drawn partially.

Hints

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

Examples

Example usage of the DrawLines_Palette on an empty image.