Back to FabImage Library website

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

TranslateRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Translates a region by a given number of pixels along each axis.

Syntax

C++
C#
 
void fil::TranslateRegion
(
	const fil::Region& inRegion,
	int inDeltaX,
	int inDeltaY,
	bool inInverse,
	ftl::Optional<int> inFrameWidth,
	ftl::Optional<int> inFrameHeight,
	fil::Region& outRegion
)

Parameters

Name Type Range Default Description
Input value inRegion const Region& Input region
Input value inDeltaX int Horizontal shift
Input value inDeltaY int Vertical shift
Input value inInverse bool Negates the delta values
Input value inFrameWidth Optional<int> 0 - 65535 NIL Output region frame width
Input value inFrameHeight Optional<int> 0 - 65535 NIL Output region frame height
Output value outRegion Region& Output region

Examples

TranslateRegion performed on the sample region with inDeltaX and inDeltaY both set to 50.

Errors

List of possible exceptions:

Error type Description
DomainError Input and output regions are not distinct in TranslateRegion.

See Also

  • RotateRegion – Rotates a region around a specified point.