Back to Aurora Vision Library website

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

DrawLines_SingleColor


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: AVL.h
Namespace: avs
Module: FoundationLite

Draws lines on an image with a single color.

Syntax

void avs::DrawLines_SingleColor
(
	const avl::Image& inImage,
	atl::Conditional<const atl::Array<atl::Conditional<avl::Line2D>>&> inLines,
	atl::Optional<const avl::CoordinateSystem2D&> inLineAlignment,
	const avl::Pixel& inColor,
	const avl::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inLines Conditional<const Array<Conditional<Line2D>>&> { }
Input value inLineAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColor const Pixel&
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Output value outImage Image& Output image

In-place Processing

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

Read more about In-place Computation.

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.
  • 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 DrawLines_SingleColor on an empty image.

See Also

  • DrawPath – Draws a path on an image.