Back to Adaptive Vision Library website

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

CreateImageTiles_AsBoxes_Deprecated


Header: AVL.h
Namespace: avl
Module: FoundationBasic

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

Syntax

void avl::CreateImageTiles_AsBoxes_Deprecated
(
	const avl::ImageFormat& inImageFormat,
	const int inTileWidth,
	atl::Optional<int> inTileHeight,
	atl::Optional<int> inHorizontalStep,
	atl::Optional<int> inVerticalStep,
	const bool inOverflowControl,
	atl::Array<avl::Box>& outTiles,
	int& outRowCount,
	int& outColumnCount
)

Parameters

Name Type Range Default Description
Input value
 inImageFormat const ImageFormat& Format of image for which tiles will be produced.
Input value
 inTileWidth const int 1 - 1 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 bool False When set to true, overflowing tiles will be removed form outTiles array.
Output value
 outTiles 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.