Back to FabImage Library website

You are here: Start » Function Reference » Image » Image IO » GrabImage_FromFiles

GrabImage_FromFiles


Header: FIL.h
Namespace: fil
Module: FoundationLite

Simulates capturing a frame from a camera.

Applications: Can be used as EnumerateImages, but its state is global in a program - does not reset when some task is finished.

Syntax

C++
C#
 
bool fil::GrabImage_FromFiles
(
	const ftl::Directory& inDirectory,
	ftl::Optional<fil::ImageFileFormat::Type> inFileType,
	fil::FileSortingOrder::Type inSortingOrder,
	bool inRepeat,
	bool inProcessSubdirectories,
	bool inInvert,
	bool inLoadAlphaChannel,
	int inDelay,
	fil::Image& outImage,
	ftl::File& outFilePath,
	ftl::String& outFileName
)

Parameters

Name Type Range Default Description
Input value inDirectory const Directory& \".\" Input directory
Input value inFileType Optional<ImageFileFormat::Type> NIL File format of the images
Input value inSortingOrder FileSortingOrder::Type Sorting order
Input value inRepeat bool Determines whether to repeat reading directory after reading all files
Input value inProcessSubdirectories bool Flag indicating whether to load images from the subdirectories or not
Input value inInvert bool Flag indicating whether to enumerate images backwards or not
Input value inLoadAlphaChannel bool Flag indicating whether to load alpha channel of the image or not
Input value inDelay int 0 - 2000
Output value outImage Image& Output image
Output value outFilePath File& Output file path
Output value outFileName String& Output file name

Description

This filter works similarly to EnumerateImages, but it behaves more like a camera: it preserves its state across the whole program.

For example, you can have two GrabImage_FromFiles filters in two different Task macrofilters. When execution of second Task starts, images loaded previously in the first Task are not loaded again.

Errors

List of possible exceptions:

Error type Description
DomainError All instances of GrabImage_FromFiles must have these same parameters.

See Also

  • EnumerateImages – Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted according to the specified order.