Back to FabImage Library website

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

EnumerateImageTiles


Header:FIL.h
Namespace:fil

Enumerates tiles from image.

Syntax

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

Parameters

Name Type Range Default Description
inImage const Image& Image to be enumerated.
inTileWidth const int 1 - 1 Demanded tile width.
inTileHeight Optional<int> 1 - Demanded tile height; equals inTileWidth when set to Auto.
inOverflowControl const bool Allow overflow.
outTile const Image&
diagTilePosition const Box& Box indicating cut out tiles location and dimensions.
outIsFirst Optional<bool> NIL Flag indicating the first iteration
outIsLast Optional<bool> NIL Flag indicating the last iteration

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