====== zmap_InitMosaic ======

===== Description =====

Initialise a map as a tiled mosaic. 

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

===== Function prototype =====

<code="C++">
bool zmap_InitMosaic(ZMAP hMap, 
                long nx, 
                long ny, 
                long MapTypeID, 
                float HorizScale, 
                bool WrapFlag, 
                const char* lpMosaicFileName, 
                long TileSize, 
                ZFORMAT hFormat, 
                const char* lpProjMapName);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hMap//  |  ''ZMAP''  | A ZMAP handle to the map variable that is to be initialised as a mosaic. |
|  //nx//  |  ''long''  | The width of the map, in pixels. |
|  //ny//  |  ''long''  | The height of the map, in pixels. |
|  //MapTypeID//  |  ''long''  | The [[zeolite:mapID|map type ID]] of the desired map type. |
|  //HorizScale//  |  ''float''  | The pixel-spacing of the map, in metres. |
|  //WrapFlag//  |  ''bool''  | A flag that states whether the east/west and north/south edges of the map 'wrap around' to give an infinitely tilable map.  |
|  //lpMosaicFileName//  |  ''const char*''  | A handle to a C-style string that contains the full path-name of the [[l3dt:formats:specs:mmf|mosaic master file]] to be used by this map. |
|  //TileSize//  | ''long'' | The width and height of the tiles in the map. |
|  //hFormat//  |  ''ZFORMAT''  | A ZFORMAT handle to the format variable to be used to load/save the mosaic. |
|  //lpProjMapName//  |  ''const char*''  | A handle to a C-style string that contains the name of the map in the project (usually null). Please refer to [[zeolite:functions:project_GetMap]] for valid map names. |

===== Return value =====

False if an error occurred, and true otherwise.

===== Comments =====

None.