Back to FabImage Library website

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

DrawShapeRegions_Palette_Deprecated


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 ShapeRegion objects on an image with multiple colors.

Syntax

void fis::DrawShapeRegions_Palette_Deprecated
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::ShapeRegionDeprecated> > &> inShapeRegions,
	ftl::Optional<const fil::CoordinateSystem2D&> inShapeRegionAlignment,
	const ftl::Optional<const ftl::Array<fil::Pixel>&>& inColors,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inShapeRegions Conditional<const Array<Conditional<ShapeRegionDeprecated> > &> { }
Input value inShapeRegionAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColors const Optional<const Array<Pixel>&>& NIL
Input value inDrawingStyle const DrawingStyle&
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.

Hints

  • Define inShapeRegions. 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.

Examples

Example usage of the DrawShapeRegions_Palette_Deprecated on an empty image.