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

EnumerateImages

Header:	FIL.h
Namespace:	fil

Scans a disk directory for image files and then returns the images one by one in consecutive iterations.

Syntax

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,
	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
ioState	EnumerateFilesState&		Object used to maintain state of the function.
inDirectory	const Directory&		Input directory
inFileType	Optional<ImageFileFormat::Type>	NIL	File format of the images
inSortingOrder	FileSortingOrder::Type		Sorting order
inRepeat	bool		Determines whether to repeat reading directory after reading all files
inProcessSubdirectories	bool		Flag indicating whether to load images from the subdirectories or not
inInvert	bool		Flag indicating whether to enumerate images backwards or not
inLoadAlphaChannel	bool		Flag indicating whether to load alpha channel of the image or not
outImage	Image&		Output image
outFilePath	File&		Output file path
outFileName	String&		Output file name
outIsFirst	Optional<bool>	NIL	Flag indicating the first iteration
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.

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.