Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Drawing » DrawGridImage

DrawGridImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Draws an image as a tile on an image considered to be a grid of tiles.

Syntax

C++
C#
 
void fil::DrawGridImage
(
	fil::Image& ioImage,
	const fil::Image& inTileImage,
	int inColumnIndex,
	int inRowIndex,
	ftl::Optional<int> inGridWidth,
	ftl::Optional<int> inGridHeight
)

Parameters

Name Type Range Default Description
Input will be modified ioImage Image&
Input value inTileImage const Image& Image to be pasted to the grid
Input value inColumnIndex int Column index in the grid
Input value inRowIndex int Row index in the grid
Input value inGridWidth Optional<int> 1 - NIL
Input value inGridHeight Optional<int> 1 - NIL

Description

The operation supports drawing image grids composed of equally sized images. The filters draws single inImage on the inImage at the location being the selected multiple of inTileImage dimensions.

Parameters pair inColumnIndex and inRowIndex set to (0, 0) draws inTileImage at the location of (0,0) pixels of the inImage.

Examples

Four consecutive instances of the DrawGridImage used to plot an image grid. Each of the filters receives different inImage and different pair of the inColumnIndex, inRowIndex parameters - accordingly: (0,0) (0,1) (1,0) (1,1).

See Also

  • DrawImage – Draws an image on another one.
  • JoinImages – Creates a single image by glueing together the two input images in horizontal or vertical direction.
  • ComposeImages – Takes pixels from the first image within the specified region and from the other one elsewhere.