You are here: Start » Function Reference » 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:	FIL.h
Namespace:	fis
Module:	FoundationLite

Draws crosshairs on an image with multiple colors.

Syntax

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

Parameters

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

In-place Processing

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

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.