Back to FabImage Library website

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

CreateImageTiles


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Generates an array of regions and an array of boxes covering the area of an image.

Syntax

C++
C#
 
void fil::CreateImageTiles
(
	const fil::Size& inImageSize,
	const int inTileWidth,
	ftl::Optional<int> inTileHeight,
	ftl::Optional<int> inHorizontalStep,
	ftl::Optional<int> inVerticalStep,
	const fil::OverflowControl::Type inOverflowControl,
	ftl::Array<fil::Region>& outTileRegions,
	ftl::Array<fil::Box>& outTileBoxes,
	int& outRowCount,
	int& outColumnCount
)

Parameters

Name Type Range Default Description
Input value inImageSize const Size& Format of image for which tiles will be produced.
Input value inTileWidth const int 1 - 32 Demanded tile width.
Input value inTileHeight Optional<int> 1 - NIL Demanded tile height; equals inTileWidth when set to Auto.
Input value inHorizontalStep Optional<int> 1 - NIL Defines horizontal space between consecutive tiles; defaults to tile width. Can be used to produce overlapping tiles.
Input value inVerticalStep Optional<int> 1 - NIL Defines vertical space between consecutive tiles; defaults to tile height. Can be used to produce overlapping tiles.
Input value inOverflowControl const OverflowControl::Type KeepLast Define what to do when overflowing tiles are present.
Output value outTileRegions Array<Region>& Array containing produced tiles.
Output value outTileBoxes Array<Box>& Array containing produced tiles.
Output value outRowCount int& Number of generated tiles rows.
Output value outColumnCount int& Number of generated tiles per row.