Back to FabImage Library website

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

CutImageIntoTiles


Header:FIL.h
Namespace:fil

Generates array of image tiles, which are cut from inImage.

Syntax

C++
C#
 
void fil::CutImageIntoTiles
(
	const fil::Image& inImage,
	const int inTileWidth,
	ftl::Optional<int> inTileHeight,
	ftl::Optional<int> inHorizontalStep,
	ftl::Optional<int> inVerticalStep,
	const fil::OverflowControl::Type inOverflowControl,
	ftl::Array<fil::Image>& outImageTiles
)

Parameters

Name Type Range Default Description
inImage const Image& Image to be cut into tiles
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 OverflowControl::Type Define what to do when overflowing tiles are present.
outImageTiles Array<Image>& Resulting image tiles

Description

Generates an array of image tiles, which are cut from inImage.

Examples

CutImageIntoTiles performed on the sample image with inOverflowControl = false.

See Also