====== CzMap======

===== Description =====

''CzMap'' is a wrapper for variables of type ''VarID_map'', and provides member functions for manipulating map data.

===== Files =====

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

===== Member data =====

''CzMap'' contains no public data.

===== Member functions =====

==== Object creation ====
  * [[zeolite:functions:czmap_Create|Create]]
  * [[zeolite:functions:czmap_CreateShared|CreateShared]]

==== Map initialisation ====

  * [[zeolite:functions:czmap_Init|Init]]
  * [[zeolite:functions:czmap_Init2|Init2]]
  * [[zeolite:functions:czmap_InitMosaic|InitMosaic]]
  * [[zeolite:functions:czmap_Free|Free]]
  * [[zeolite:functions:czmap_GetAllocMode|GetAllocMode]]

==== Map size and scaling ====

  * [[zeolite:functions:czmap_nx|nx]]
  * [[zeolite:functions:czmap_ny|ny]]
  * [[zeolite:functions:czmap_nPixels|nPixels]]
  * [[zeolite:functions:czmap_GetHorizScale|GetHorizScale]]
  * [[zeolite:functions:czmap_SetHorizScale|SetHorizScale]]
  * [[zeolite:functions:czmap_GetTileSize|GetTileSize]]
  * [[zeolite:functions:czmap_GetTileCountX|GetTileCountX]]
  * [[zeolite:functions:czmap_GetTileCountY|GetTileCountY]]
  * [[zeolite:functions:czmap_GetMinMaxAlt|GetMinMaxAlt]]
  * [[zeolite:functions:czmap_SetMinMaxAlt|SetMinMaxAlt]]

==== Pixel access ====
  * [[zeolite:functions:czmap_GetPixel|GetPixel]]
  * [[zeolite:functions:czmap_GetPixel (2)|GetPixel (2)]]
  * [[zeolite:functions:czmap_SetPixel|SetPixel]]
  * [[zeolite:functions:czmap_SetPixel (2)|SetPixel (2)]]
  * [[zeolite:functions:czmap_LinInterp|LinInterp]]

==== Settings and flags ====
  * [[zeolite:functions:czmap_GetMapType|GetMapType]]
  * [[zeolite:functions:czmap_GetPixelSize|GetPixelSize]]
  * [[zeolite:functions:czmap_GetWrapFlag|GetWrapFlag]]
  * [[zeolite:functions:czmap_SetWrapFlag|SetWrapFlag]]
  * [[zeolite:functions:czmap_GetBusyFlag|GetBusyFlag]]
  * [[zeolite:functions:czmap_SetBusyFlag|SetBusyFlag]]
  * [[zeolite:functions:czmap_GetMosaicFlag|GetMosaicFlag]]
  * [[zeolite:functions:czmap_GetFlag|GetFlag]]
  * [[zeolite:functions:czmap_SetFlag|SetFlag]]
  * [[zeolite:functions:czmap_GetSettingsList|GetSettingsList]]
  * [[zeolite:functions:czmap_GetNameInProject|GetNameInProject]]

==== File input and output ====

  * [[zeolite:functions:czmap_SaveFile|SaveFile]]
  * [[zeolite:functions:czmap_LodeFile|LodeFile]]
  * [[zeolite:functions:czmap_LoadMosaic|LoadMosaic]]
  * [[zeolite:functions:czmap_SaveMosaic|SaveMosaic]]
  * [[zeolite:functions:czmap_SaveMosaicAs|SaveMosaicAs]]
  * [[zeolite:functions:czmap_GetFormat|GetFormat]]
  * [[zeolite:functions:czmap_SetFormat|SetFormat]]
  * [[zeolite:functions:czmap_GetFilename|GetFilename]]
  * [[zeolite:functions:czmap_ExportMap|ExportMap]]
  * [[zeolite:functions:czmap_ExportMosaic|ExportMosaic]]

==== Mosaic functions ====
  * [[zeolite:functions:czmap_CombineMosaic|CombineMosaic]]
  * [[zeolite:functions:czmap_SplitToMosaic|SplitToMosaic]]

==== Mipmaps ====

  * [[zeolite:functions:czmap_GenMimpaps|GenMimpaps]]
  * [[zeolite:functions:czmap_ClearMipmaps|ClearMipmaps]]
  * [[zeolite:functions:czmap_GetMipmapLevel|GetMipmapLevel]]
  * [[zeolite:functions:czmap_GetMipmapResStep|GetMipmapResStep]]
  * [[zeolite:functions:czmap_GetMipmapMaxLevel|GetMipmapMaxLevel]]

==== Direct memory access ====

  * [[zeolite:functions:czmap_GetDataPtr|GetDataPtr]]
  * [[zeolite:functions:czmap_OpenDirectInterface|OpenDirectInterface]]
  * [[zeolite:functions:czmap_CloseDirectInterface|CloseDirectInterface]]
  * [[zeolite:functions:czmap_GetScanlinePtr|GetScanlinePtr]]
  * [[zeolite:functions:czmap_GetScanlineArray|GetScanlineArray]]
  * [[zeolite:functions:czmap_GetAt|GetAt]]
  * [[zeolite:functions:czmap_IsContiguous|IsContiguous]]
  * [[zeolite:functions:czmap_MakeContiguous|MakeContiguous]]
  * [[zeolite:functions:czmap_AsContiguousMap|AsContiguousMap]]

===== Base class =====

  * [[zeolite:classes:CzVar]]
    * [[zeolite:classes:CzVar#Member functions]]
    * [[zeolite:classes:CzVar#Member data]]