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

CreateImageTiles_AsRegions_Deprecated

Header:	FIL.h
Namespace:	fil

Generates array of Regions, which divide image in, potentially overlapping, tiles.

Syntax

void fil::CreateImageTiles_AsRegions_Deprecated
(
	const fil::ImageFormat& inImageFormat,
	const int inTileWidth,
	ftl::Optional<int> inTileHeight,
	ftl::Optional<int> inHorizontalStep,
	ftl::Optional<int> inVerticalStep,
	const bool inOverflowControl,
	ftl::Array<fil::Region>& outTiles,
	int& outRowCount,
	int& outColumnCount
)

Parameters

Name	Type	Range	Default	Description
inImageFormat	const ImageFormat&			Format of image for which tiles will be produced.
inTileWidth	const int	1 -	1	Demanded tile width.
inTileHeight	Optional<int>	1 -	NIL	Demanded tile height; equals inTileWidth when set to Auto.
inHorizontalStep	Optional<int>	1 -	NIL	Defines horizontal space between consecutive tiles; defaults to tile width. Can be used to produce overlapping tiles.
inVerticalStep	Optional<int>	1 -	NIL	Defines vertical space between consecutive tiles; defaults to tile height. Can be used to produce overlapping tiles.
inOverflowControl	const bool		False	When set to true, overflowing tiles will be removed form outTiles array.
outTiles	Array<Region>&			Array containing produced tiles.
outRowCount	int&			Number of generated tiles rows.
outColumnCount	int&			Number of generated tiles per row.