http://www.bundysoft.com/docs/ 2026-04-30T15:10:48+00:00 http://www.bundysoft.com/docs/ http://www.bundysoft.com/docs/lib/images/favicon.ico text/html 2017-08-31T06:44:14+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzbyteswap&rev=1504161854&do=diff Description Swap the byte ordering of a binary object/array from short-endian to long-endian, or vice-versa. Function prototype long hfzByteSwap(void* pData, unsigned long DataSize); Arguments Name Type Comment pData void* A pointer to the object or array whose endianness is to be swapped. DataSize unsigned long The size, in bytes, of the object or array addressed by pData. Return value LIBHFZ_STATUS_OK if the byte order was swapped successfully, and otherwise an error code. Us… text/html 2017-08-31T04:15:30+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzclose&rev=1504152930&do=diff Description Close a HF2/HFZ file for reading/writing. Function prototype void hfzClose(hfzFile* fs); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). Return value None (void). Comments None. text/html 2017-08-31T05:28:22+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzextheaderblock_init&rev=1504157302&do=diff Description Initialise an set data in an extended header block (hfzExtHeaderBlock struct). Function prototype long hfzExtHeaderBlock_Init(hfzExtHeaderBlock* pBlock, const char* lpBlockType, const char* lpBlockName, unsigned long BlockDataLength, void* pBlockData); text/html 2017-08-31T04:15:39+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzextheaderblock_initex&rev=1504152939&do=diff Description Initialise an set data in an extended header block (hfzExtHeaderBlock struct), which is contained in the extended header array within a hfzHeader struct. Function prototype long hfzExtHeaderBlock_InitEx(hfzHeader& fh, long BlockID, const char* lpBlockType, const char* lpBlockName, unsigned long BlockDataLength, void* pBlockData); text/html 2017-08-31T07:15:12+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzextheaderblock_reset&rev=1504163712&do=diff Description Reset the contents of a hfzExtHeaderBlock struct and release any allocated memory. Function prototype void hfzExtHeaderBlock_Reset(hfzExtHeaderBlock* pBlock); Arguments Name Type Comment pBlock hfzExtHeaderBlock A handle to the hfzExtHeaderBlock to be reset. Return value None (void). text/html 2017-08-31T06:12:42+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzfree&rev=1504159962&do=diff Description Release a block of memory allocated using hfzMalloc. Function prototype void hfzFree(void* pData); Arguments Name Type Comment pData void* A pointer to be block of memory to be released. Return value None. Comments None. text/html 2017-08-31T05:03:52+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzgeterrorstr&rev=1504155832&do=diff Description Retrieve a description string for a LibHFZ error code. Function prototype const char* hfzGetErrorStr(long ErrorCode); Arguments Name Type Description ErrorCode long A LibHFZ error code. Return value A handle to a null-terminated string containing the error description. text/html 2017-08-31T04:51:57+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzheader_decodeextheaderbuf&rev=1504155117&do=diff Description Decode a byte array from the extended header field of a HF2/HFZ file into the array of hfzExtHeaderBlock structs in a hfzHeader struct (see pExtHeaderBlocks member). Function prototype long hfzHeader_DecodeExtHeaderBuf(hfzHeader &fh, char* pBuf); text/html 2017-08-31T04:21:00+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzheader_encodeextheaderbuf&rev=1504153260&do=diff Description Encode the array of hfzExtHeaderBlock structs in a hfzHeader struct (see pExtHeaderBlocks member) into a byte array. Function prototype long hfzHeader_EncodeExtHeaderBuf(hfzHeader &fh, char** ppBuf); Arguments Name Type Comment fh hfzHeader& The hfzHeader struct containing the initialised array of hfzExtHeaderBlock structs (see pExtHeaderBlocks member) that shall be compiled into a byte array. pBuf char* A handle to an uninitialised raw byte pointer, which shall be init… text/html 2017-08-31T05:33:05+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzheader_init&rev=1504157585&do=diff Description Initialise a hfzHeader struct. Function prototype long hfzHeader_Init(hfzHeader &fh, long nx, long ny, unsigned short TileSize, float Precis, float HorizScale, long nExtHeaderBlocks); Arguments Name Type Comment fh hfzHeader& The hfzHeader struct to be initialised. nx long The width of the map, in pixels. ny long The height of the map, in pixels. TileSize unsigned short The tile size used within the HF2/HFZ file for compression. Allowed values are 8...65535. Pre… text/html 2017-08-31T05:25:17+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzheader_reset&rev=1504157117&do=diff Description Reset the contents of a hfzHeader struct and release any allocated memory. Function prototype void hfzHeader_Reset(hfzHeader &fh); // clears mem in ext header buf and restores defaults Arguments Name Type Description fh hfzHeader& The hfzHeader struct to be reset. Return value None (void). text/html 2017-08-31T05:36:09+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzload&rev=1504157769&do=diff Description Load a HF2/HFZ file from disk into memory. Unlike hfzLoadEx, this function does not automatically allocate the memory block. Function prototype long hfzLoad(const char* lpFileName, hfzHeader& fh, float * pData, LIBHFZ_PROG_CALLBACK lpProgCallback, void* lpCallbackParam); text/html 2017-08-31T06:01:25+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzloadex&rev=1504159285&do=diff Description Load a HF2/HFZ file from disk into memory. Unlike hfzLoad, this function automatically allocates the memory block. Function prototype long hfzLoadEx(const char* lpFileName, hfzHeader& fh, float** h_pData, LIBHFZ_PROG_CALLBACK lpProgCallback, void* lpCallbackParam); text/html 2017-08-31T04:32:21+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzmalloc&rev=1504153941&do=diff Description Allocate a block of memory, and initialise with zeros. Function prototype void* hfzMalloc(long nBytes); Arguments Name Type Comment nBytes long The number of bytes to be allocated. Return value NULL if the memory could not be allocated, and a non-null pointer otherwise. text/html 2017-08-31T07:21:39+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzmemcpy&rev=1504164099&do=diff Description Copy a specified number of bytes from one memory location to another. Function prototype void* hfzMemcpy(void* pDest, const void* pSrc, long nBytes); Arguments Name Type Comment pDest void* A pointer to the destination array. pSrc void* A pointer to the source array. nBytes long The number of bytes to be copied from source to destination. Return value pDest is returned. text/html 2017-08-31T05:49:57+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzopen&rev=1504158597&do=diff Description Open a HF2/HFZ file for reading or writing. Function prototype hfzFile* hfzOpen(const char* lpFileName, long Format, const char* lpMode); Arguments Name Type Description lpFileName const char* The name of the file to be opened. Format long The type of file to be opened. May be either LIBHFZ_FORMAT_HF2 (uncompressed) or LIBHFZ_FORMAT_HF2_GZ (compressed). lpMode const char* The access mode to be used. May be “wb” (for writing), or “rb” (for reading). Return value … text/html 2017-08-31T04:43:14+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzread&rev=1504154594&do=diff Description Read bytes from a HF2/HFZ file. Function prototype long hfzRead(hfzFile* fs, void* pData, int len); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). pData void* A handle to the memory block into which data will be read. len long The number of bytes to be read. Return value The number of bytes read (if positive), or else an error code (if negative). Use hfzGetErrorStr to retrieve the error description. text/html 2017-08-31T06:10:39+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzreadheader&rev=1504159839&do=diff Description Read the header from an open HF2/HFZ file. Function prototype long hfzReadHeader(hfzFile* fs, hfzHeader& fh); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). fh hfzHeader& The hfzHeader struct into which the file header data will be read. Return value LIBHFZ_STATUS_OK if the header was read successfully, and otherwise an error code. Use hfzGetErrorStr to retrieve the error description. text/html 2017-08-31T04:55:58+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzreadheader2&rev=1504155358&do=diff Description Read a header from a HF2/HFZ file. Function prototype long hfzReadHeader2(const char* lpFileName, hfzHeader& fh); Arguments Name Type Description lpFileName const char* The name of the file from which the header will be read. fh hfzHeader& The hfzHeader struct into which the file header data will be read. Return value LIBHFZ_STATUS_OK if the header was read successfully, and otherwise an error code. Use hfzGetErrorStr to retrieve the error description. text/html 2017-08-31T05:24:36+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzreadtile&rev=1504157076&do=diff Description Read a map data tile from an open HF2/HFZ file. Function prototype long hfzReadTile(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pMapData); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). fh hfzHeader& The hfzHeader struct for the file. TileX long The x-coordinate of the map tile. TileY long The y-coordinate of the map tile. pMapData float* A handle to the user-supplied map array (see comments). Return value… text/html 2017-08-31T05:18:40+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzreadtile2&rev=1504156720&do=diff Description Read a map data tile from an open HF2/HFZ file. This function uses a smaller memory block (tile-sized) for loading the map data, as opposed to the complete memory block (map-sized) used in hfzReadTile. Function prototype long hfzReadTile2(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pTileData); text/html 2017-08-31T05:34:58+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzsave&rev=1504157698&do=diff Description Save a floating-point map as a HF2/HFZ file. Function prototype long hfzSave(const char* lpFileName, long Format, hfzHeader& fh, float* pData, LIBHFZ_PROG_CALLBACK lpProgCallback, void* lpCallbackParam); Arguments Name Type Comment lpFileName const char* The file name of the file to be saved. Format long The type of file to be opened. May be either LIBHFZ_FORMAT_HF2 (uncompressed) or LIBHFZ_FORMAT_HF2_GZ (compressed). fh hfzHeader& The hfzHeader struct to be written … text/html 2017-08-31T07:17:53+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzsetlocalbyteorder&rev=1504163873&do=diff Description Set the local byte ordering in LibHFZ. If this function is not called, the assumed byte order is little-endian (Intel / Windows). Function prototype TYPE hfzSetLocalByteOrder(long ByteOrder); Arguments Name Type Comment ByteOrder long The local byte order. See comments for allowed values. Return value LIBHFZ_ERROR_INVALID_PARAM if the byte order is not supported, and STATUS_OK LIBHFZ_STATUS_OK otherwise. text/html 2017-08-31T07:00:46+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzwrite&rev=1504162846&do=diff Description Write bytes to a HF2/HFZ file. Function prototype long hfzWrite(hfzFile* fs, void* pData, long len); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). pData void* A handle to the data to be written. len long The number of bytes to be written. Return value The number of bytes written (if positive), or else an error code (if negative). Use hfzGetErrorStr to retrieve the error description. text/html 2017-08-31T06:47:10+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzwriteheader&rev=1504162030&do=diff Description Write a header to an open HF2/HFZ file. Function prototype long hfzWriteHeader(hfzFile* fs, hfzHeader& fh); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). fh hfzHeader& The hfzHeader struct to be written to the file. Return value LIBHFZ_STATUS_OK if the header was written successfully, and otherwise an error code. Use hfzGetErrorStr to retrieve the error description. text/html 2017-08-31T05:04:00+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzwritetile&rev=1504155840&do=diff Description Write a map data tile to an open HF2/HFZ file. Function prototype long hfzWriteTile(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pMapData); Arguments Name Type Description fs hfzFile* A handle to an open hfzFile struct (see ). fh hfzHeader& The hfzHeader struct for the file. TileX long The x-coordinate of the map tile. TileY long The y-coordinate of the map tile. pMapData float* A handle to the user-supplied map array (see comments). Return value… text/html 2017-08-31T06:51:47+00:00 http://www.bundysoft.com/docs/doku.php?id=libhfz:functions:hfzwritetile2&rev=1504162307&do=diff Description Write a map data tile to an open HF2/HFZ file. This function uses a smaller memory block (tile-sized) for loading the map data, as opposed to the complete memory block (map-sized) used in hfzWriteTile. Function prototype long hfzWriteTile2(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pTileData);