====== hfzReadTile2 ======

===== 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 [[libhfz:functions:hfzReadTile]].

===== Function prototype =====
<code>
long hfzReadTile2(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pTileData);
</code>

===== Arguments =====
^ Name ^ Type ^ Description ^
| fs | hfzFile* | A handle to an open hfzFile struct (see [[#hfzOpen]]). |
| 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. |
| pTileData | float* | A handle to the user-supplied tile array (see comments). |


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

LIBHFZ_STATUS_OK if the tile was read successfully, and otherwise an error code. Use [[libhfz:functions:hfzGetErrorStr]] to retrieve the error description. 

===== Comments =====

==== Tile order ====

Please refer to the [[:l3dt:formats:specs:hf2#map_data|HF2 file specification]] for the required tile order.

==== Regarding pTileData ====

//pTileData// is a user-supplied handle to an array of floats with a length of //TileSize// * //TileSize// (as defined in the hfzHeader). The caller is responsible for initialising this memory before the function call and releasing it afterwards.