Back to Adaptive Vision Library website
You are here: Start » Function Reference » Image IO » EnumerateImages
EnumerateImages
Scans a disk directory for image files and then returns the images one by one in consecutive iterations.
Syntax
bool avl::EnumerateImages ( EnumerateFilesState& ioState, const atl::Directory& inDirectory, atl::Optional<avl::ImageFileFormat::Type> inFileType, avl::FileSortingOrder::Type inSortingOrder, bool inRepeat, bool inProcessSubdirectories, bool inInvert, bool inLoadAlphaChannel, avl::Image& outImage, atl::File& outFilePath, atl::String& outFileName )
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 | Sort order: Name, Size, Date or Path | ||
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 |
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 Adaptive Vision Studio.