Back to FabImage Library websiteYou are here:
Start »
Function Reference »
Image »
Image Spatial Transforms »
JoinImages
Header: |
FIL.h
|
Namespace: |
fil |
Module: |
FoundationLite |
Creates a single image by glueing together the two input images in horizontal or vertical direction.
Syntax
C++
C#
void fil::JoinImages
(
const fil::Image& inImage1,
const fil::Image& inImage2,
ftl::Optional<const fil::Image&> inImage3,
ftl::Optional<const fil::Image&> inImage4,
fil::JoinDirection::Type inDirection,
const int inMargin,
fil::Image& outImage
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
|
inImage1 |
const Image& |
|
|
First input image |
|
inImage2 |
const Image& |
|
|
Second input image |
|
inImage3 |
Optional<const Image&> |
|
NIL |
Third input image |
|
inImage4 |
Optional<const Image&> |
|
NIL |
Fourth input image |
|
inDirection |
JoinDirection::Type |
|
|
Direction in which images are joined |
|
inMargin |
const int |
0 - |
0 |
Thickness (in pixels) of black frame around joined images |
|
outImage |
Image& |
|
|
Output image |
Examples
JoinImages used to join two images side by side into a single image.
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Input images do not have compatible dimensions in JoinImages. |
DomainError |
Input images do not have the same pixel format in JoinImages. |
DomainError |
Unknown value of JoinDirection in JoinImages. |