Back to FabImage Library websiteYou are here:
Start »
Function Reference »
Region »
Region Spatial Transforms »
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 |
|
inRegion |
const Region& |
|
|
Input region |
|
inDeltaX |
int |
|
|
Horizontal shift |
|
inDeltaY |
int |
|
|
Vertical shift |
|
inInverse |
bool |
|
|
Negates the delta values |
|
inFrameWidth |
Optional<int> |
0 - 65535 |
NIL |
Output region frame width |
|
inFrameHeight |
Optional<int> |
0 - 65535 |
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
List of possible exceptions:
Error type |
Description |
DomainError |
Input and output regions are not distinct in TranslateRegion. |
See Also