Back to FabImage Library website

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

EnumerateImages


Header: FIL.h
Namespace: fil
Module: FoundationLite

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

Applications: Emulates image acquisition with images stored on disk.

Syntax

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

Parameters

Name Type Default Description
Input will be modified ioState EnumerateFilesState& Object used to maintain state of the function.
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 const int Minimum time between iterations in milliseconds
Output value outImage Image& Output image
Output value outFilePath File& Output file path
Output value outFileName String& Output file name
Output value outIsFirst Optional<bool&> NIL Flag indicating the first iteration
Output value outIsLast Optional<bool&> NIL Flag indicating the last iteration

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outIsFirst, outIsLast.

Read more about Optional Outputs.

Hints

  • Set inDirectory to specify where on your disk are the images you want to load.
  • This filter can also be added easily by dragging and dropping a disk directory from Windows Explorer to the Program Editor in FabImage Studio.