Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Tiling » EnumerateImageTiles

EnumerateImageTiles


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Enumerates tiles from image.

Syntax

C++
C#
 
bool fil::EnumerateImageTiles
(
	EnumerateImageTilesState& ioState,
	const fil::Image& inImage,
	int inTileWidth,
	ftl::Optional<int> inTileHeight,
	bool inOverflowControl,
	const int inDelay,
	fil::Image& outTile,
	ftl::Optional<bool&> outIsFirst = ftl::NIL,
	ftl::Optional<bool&> outIsLast = ftl::NIL,
	fil::Box& diagTilePosition = ftl::Dummy<fil::Box>()
)

Parameters

Name Type Range Default Description
Input will be modified ioState EnumerateImageTilesState& Object used to maintain state of the function.
Input value inImage const Image& Image to be enumerated
Input value inTileWidth int 1 - 1 Tile width
Input value inTileHeight Optional<int> 1 - NIL Tile height
Input value inOverflowControl bool Allow overflow
Input value inDelay const int Minimum time between iterations in milliseconds
Output value outTile Image&
Output value outIsFirst Optional<bool&> NIL Flag indicating the first iteration
Output value outIsLast Optional<bool&> NIL Flag indicating the last iteration
Diagnostic input diagTilePosition Box& Cut out tile position.

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outIsFirst, outIsLast.

Read more about Optional Outputs.

Description

Cuts out a tile from inImage and serves them one by one. Tile dimensions cannot be changed during image traversal.

Examples

EnumerateImageTiles performed on the sample image with inOverflowControl = true.

See Also

  • CutImageIntoTiles – Generates an array of small images by cutting the input image.