GrabImage_FromFiles


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++
Python
 
def GrabImage_FromFiles(
	inDirectory: str,
	outImage: Image,
	/,
	*,
	inFileType: ImageFileFormat | None = None,
	inSortingOrder: FileSortingOrder = FileSortingOrder.Name,
	inRepeat: bool = False,
	inProcessSubdirectories: bool = False,
	inInvert: bool = False,
	inLoadAlphaChannel: bool = False,
	inDelay: int = 0
)
-> (
	outResult: bool,
	outFilePath: str,
	outFileName: str
)

Parameters

Name Type Range Default Description
Input value inDirectory str Input directory
Input value inFileType ImageFileFormat | None None File format of the images
Input value inSortingOrder FileSortingOrder FileSortingOrder.Name Sorting order
Input value inRepeat bool False Determines whether to repeat reading directory after reading all files
Input value inProcessSubdirectories bool False Flag indicating whether to load images from the subdirectories or not
Input value inInvert bool False Flag indicating whether to enumerate images backwards or not
Input value inLoadAlphaChannel bool False Flag indicating whether to load alpha channel of the image or not
Input value inDelay int 0 - 2000 0
Output value outImage Image Output image
Output value outFilePath str Output file path
Output value outFileName str Output file name