Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Image Drawing » DrawCrosshairs_MultiColor

DrawCrosshairs_MultiColor


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

Draws crosshairs on an image with multiple colors.

Syntax

void avs::DrawCrosshairs_MultiColor
(
	const avl::Image& inImage,
	const atl::Conditional<const atl::Array<atl::Conditional<avl::Location>>&> inLocations,
	atl::Optional<const avl::CoordinateSystem2D&> inLocationAlignment,
	atl::Optional<const atl::Array<atl::Conditional<avl::Hash>>&> inColorIds,
	atl::Optional<const atl::Array<avl::Pixel>&> inPalette,
	const avl::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	const avl::CrosshairShape::Type inCrosshairShape,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inLocations const Conditional<const Array<Conditional<Location>>&> { }
Input value inLocationAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColorIds Optional<const Array<Conditional<Hash>>&> NIL
Input value inPalette Optional<const Array<Pixel>&> NIL
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 5.0f Filled: False PointShape: Nil PointSize: 50.0f )
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Input value inCrosshairShape const CrosshairShape::Type RoundFrame
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.

Errors

List of possible exceptions:

Error type Description
DomainError Empty inPalette while inLocations has objects to draw in DrawCrosshairs_MultiColor.
DomainError No palette defined with inPalette for specified inColorIds in DrawCrosshairs_MultiColor.
DomainError The sizes inLocations and inColorIds do not match in DrawCrosshairs_MultiColor.