You are here: Start » Function Reference » All Functions » Loop Generators » Loop

Loop

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Generates a loop that ends at the first invocation with False on the input.

Applications: Put this filter into a task that should have a loop, but does not have any other loop generators (e.g. GrabImage).

Syntax

bool avl::Loop
(
	DelayByPeriodState& ioState,
	bool inShouldLoop,
	int inDelay = 0
)

Parameters

	Name	Type	Default	Description
	ioState	DelayByPeriodState&		Object used to maintain state of the function.
	inShouldLoop	bool	True	If 'True' the loop will be continued
	inDelay	int	0	Time between iterations in milliseconds