zmap_GetScanlineArray

zmap_GetScanlineArray

Description

Get the pointer to the array of scanlines of a map.

Files

Declaration	`Zeolite.h`
Implementation	`Zeolite.cpp`

Function prototype

void** zmap_GetScanlineArray(ZMAP hMap);

Arguments

Name	Type	Comment
hMap	`ZMAP`	A ZMAP handle to a map.

Return value

A null pointer if:

The map is not initialised, or;
The map is a mosaic (See zmap_GetMosaicFlag), or;
The map is allocated as a contiguous block of memory (See zmap_IsContiguous), or;
An error occurred.

Otherwise, the return value is the pointer to an array of pointers to the scanlines. The length of the array is given by zmap_GetHeight. Each member of the scanline array is a pointer to the first pixel of each scanline. The length of each scanline is given by zmap_GetWidth, and the type and size of the pixel data in the scanlines may be retrieved from zmap_GetMapType and zmap_GetPixelSize.

Comments

None.