Back to FabImage Library website

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

JoinImages_OfArray


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a single image by glueing together many input images in horizontal or vertical direction.

Syntax

C++
C#
 
void fil::JoinImages_OfArray
(
	const ftl::Array<fil::Image>& inImages,
	fil::JoinDirection::Type inDirection,
	const int inMargin,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value
 inImages const Array<Image>& Array of input images
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 multiple image stripes into a single image.

Errors

List of possible exceptions:

Error type Description
DomainError Input images do not have compatible dimensions in JoinImages_OfArray.
DomainError Input images do not have the same pixel format in JoinImages_OfArray.
DomainError Unknown value of JoinDirection in JoinImages_OfArray.