Main Page   Compound List   File List   Compound Members   File Members  

FireExportImg.c File Reference

#include "FireExportImg.h"

Go to the source code of this file.


int FireExportFireIDPng (ChHashTable * proptbl, FireYear * fyr, FireTimer * ft)
 Exports current maximum extent of all fires burning in simulation as PNG image. More...

Detailed Description

Marco Morais

HFire (Highly Optmized Tolerance Fire Spread Model) Library Copyright (C) 2001 Marco Morais

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file FireExportImg.c.

Function Documentation

int FireExportFireIDPng ( ChHashTable * proptbl,
FireYear * fyr,
FireTimer * ft )

Exports current maximum extent of all fires burning in simulation as PNG image.

Must have USING_GD defined in order to enable this functionality.

See also:
ChHashTable , FireYear , FireTimer , Check the config file documentation
proptbl   ChHashTable of simulation properties
fyr   current extent of all active fires in FireYear
ft   current simulation time stored in FireTimer
Return values:
ERR_SUCCESS   (0) if operation successful, an error code otherwise
Best use of this facility is as follows:
            int error_status = SomeFunctionXXX();
            if ( error_status )
                // something bad happened

Definition at line 27 of file FireExportImg.c.

Generated at Fri Jun 22 00:46:52 2001 for HFire by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000