Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Spatial Transforms » TrimRegionToPolygon

TrimRegionToPolygon


Header: FIL.h
Namespace: fil
Module: FoundationPro

Removes region elements lying beyond the specified polygon.

Syntax

C++
C#
 
void fil::TrimRegionToPolygon
(
	const fil::Region& inRegion,
	const fil::Path& inPolygon,
	fil::Region& outRegion
)

Parameters

Name Type Default Description
Input value
 inRegion const Region& Input region
Input value
 inPolygon const Path&
Output value
 outRegion Region& Output region

Errors

List of possible exceptions:

Error type Description
DomainError Path is not closed in TrimRegionToPolygon.