You are here: Start » AVL.NET » Function Reference » Image » Image IO » AVL.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.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static bool EnumerateImages ( AvlNet.EnumerateFilesState ioState, string inDirectory, AvlNet.ImageFileFormat? inFileType, AvlNet.FileSortingOrder inSortingOrder, bool inRepeat, bool inProcessSubdirectories, bool inInvert, bool inLoadAlphaChannel, int inDelay, AvlNet.Image outImage, out string outFilePath, out string outFileName, NullableValue<bool> outIsFirst, NullableValue<bool> outIsLast )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | AvlNet.EnumerateFilesState | ||||
inDirectory | string | \".\" | Input directory. Default value: ".". | ||
inFileType | AvlNet.ImageFileFormat? | File format of the images. Default value: atl::NIL. | |||
inSortingOrder | AvlNet.FileSortingOrder | 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. | |||
inDelay | int | Minimum time between iterations in milliseconds. | |||
outImage | AvlNet.Image | Output image. | |||
outFilePath | string | Output file path. | |||
outFileName | string | Output file name. | |||
outIsFirst | AvlNet.NullableValue<bool> | Flag indicating the first iteration. Can be null to skip this parameter calculation. | |||
outIsLast | AvlNet.NullableValue<bool> | Flag indicating the last iteration. Can be null to skip this parameter calculation. |
Function Overrides
- EnumerateImages(EnumerateFilesState, String, FileSortingOrder, Boolean, Boolean, Boolean, Boolean, Int32, Image, String, String)
- EnumerateImages(EnumerateFilesState, String, Nullable<ImageFileFormat>, FileSortingOrder, Boolean, Boolean, Boolean, Boolean, Int32, Image, String, String)
- EnumerateImages(EnumerateFilesState, String, Nullable<ImageFileFormat>, FileSortingOrder, Boolean, Boolean, Boolean, Boolean, Int32, Image, String, String, Boolean, Boolean)