L3DT documentation
	Large 3D terrain generator

Nav | start » libhfz » functions » hfzreadtile2

hfzReadTile2

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 hfzReadTile.

Function prototype

long hfzReadTile2(hfzFile* fs, hfzHeader& fh, long TileX, long TileY, float* pTileData);

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 hfzGetErrorStr to retrieve the error description.

Comments

Tile order

Please refer to the 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.

libhfz/functions/hfzreadtile2.txt · Last modified: 2017/08/31 05:18 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported