Back to Adaptive Vision Library website

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

TranslateRegion


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

Syntax

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

Parameters

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

Examples

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

Errors

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

See Also