Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Spatial Transforms » JoinImages

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
Input value inImage1 const Image& First input image
Input value inImage2 const Image& Second input image
Input value inImage3 Optional<const Image&> NIL Third input image
Input value inImage4 Optional<const Image&> NIL Fourth input image
Input value inDirection JoinDirection::Type Direction in which images are joined
Input value inMargin const int 0 - 0 Thickness (in pixels) of black frame around joined images
Output value 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.