Table of Contents
LibHFZ functions
High-level functions
Medium-level functions
Low-level functions (overridables)
Helper functions
Header manipulation
Extended header manipulation
Byte order handling
Error processing
LibHFZ functions
High-level functions
hfzSave
— Save a float map as a HF2/HFZ file.
hfzLoad
— Load a float map from a HF2/HFZ file.
hfzLoadEx
— Load a float map from a HF2/HFZ file, and automatically allocates required memory.
Medium-level functions
hfzReadHeader
— Read a hfzHeader from a HF2/HFZ file (already open).
hfzReadHeader2
— Read a hfzHeader from a HF2/HFZ file (not already open).
hfzReadTile
— Read a map data tile from a HF2/HFZ file (uses map memory block).
hfzReadTile2
— Read a map data tile from a HF2/HFZ file (uses tile memory block).
hfzWriteHeader
— Write a hfzHeader to a HF2/HFZ file.
hfzWriteTile
— Write a map data tile to a HF2/HFZ file (uses map memory block).
hfzWriteTile2
— Write a map data tile to a HF2/HFZ file (uses tile memory block).
Low-level functions (overridables)
hfzOpen
— Open a HF2/HFZ file for reading or writing.
hfzClose
— Close an open HF2/HFZ file.
hfzRead
— Read bytes from an open HF2/HFZ file.
hfzWrite
— Write bytes to an open HF2/HFZ file.
hfzMalloc
— Allocate memory.
hfzMemcpy
— Copy memory.
hfzFree
— Free memory.
Helper functions
Header manipulation
hfzHeader_Init
— Initialise a hfzHeader struct.
hfzHeader_Reset
— De-allocate memory in hfzHeader struct.
hfzHeader_EncodeExtHeaderBuf
— Convert the extended header block array in a hfzHeader struct into a byte array.
hfzHeader_DecodeExtHeaderBuf
— Convert a byte array into an array of extended header blocks in a hfzHeader struct.
Extended header manipulation
hfzExtHeaderBlock_Init
— Initialise a hfzExtHeaderBlock struct.
hfzExtHeaderBlock_InitEx
— Initialise a hfzExtHeaderBlock struct in the extended header array of a hfzHeader struct.
hfzExtHeaderBlock_Reset
— De-allocate memory in hfzExtHeaderBlock struct.
Byte order handling
hfzSetLocalByteOrder
— Set the byte order of the local machine.
hfzByteSwap
— Swap the byte ordering of a binary buffer/object.
Error processing
hfzGetErrorStr
— Convert a LibHFZ error code to an error description string.