Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Basics » LocationsToRegion

LocationsToRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Forms a region containing pixels of given locations.

Syntax

C++
C#
 
void fil::LocationsToRegion
(
	const ftl::Array<fil::Location>& inLocations,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion
)

Parameters

Name Type Range Default Description
Input value
 inLocations const Array<Location>&
Input value
 inFrameWidth int 0 - 65535
Input value
 inFrameHeight int 0 - 65535
Output value
 outRegion Region& Output region

Description

The operation forms a region equivalent to the given array of pixel locations. If any of the parameters inFrameWidth, inFrameHeight is not provided, it is set to the smallest value that allows to contain all locations inside of the region.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with.

See Also