gui_image.h

00001 /***************************************************************************
00002  *   Copyright (C) 2005-2008 by the FIFE team                              *
00003  *   http://www.fifengine.de                                               *
00004  *   This file is part of FIFE.                                            *
00005  *                                                                         *
00006  *   FIFE is free software; you can redistribute it and/or                 *
00007  *   modify it under the terms of the GNU Lesser General Public            *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2.1 of the License, or (at your option) any later version.    *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful,       *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the                 *
00018  *   Free Software Foundation, Inc.,                                       *
00019  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
00020  ***************************************************************************/
00021 
00022 #ifndef FIFE_GUI_IMAGE_H
00023 #define FIFE_GUI_IMAGE_H
00024 
00025 // Standard C++ library includes
00026 
00027 // 3rd party library includes
00028 #include <guichan/color.hpp>
00029 #include <guichan/image.hpp>
00030 
00031 // FIFE includes
00032 // These includes are split up in two parts, separated by one empty line
00033 // First block: files included from the FIFE root src directory
00034 // Second block: files included from the same folder
00035 #include "util/base/fife_stdint.h"
00036 #include "video/image.h"
00037 #include "video/imagemanager.h"
00038 
00039 namespace FIFE {
00040 
00041     class GuiImage : public gcn::Image {
00042     public:
00043         GuiImage();
00044         GuiImage(ImagePtr img);
00045         ~GuiImage();
00046         void free();
00047         int32_t getWidth() const;
00048         int32_t getHeight() const;
00049         gcn::Color getPixel(int32_t x, int32_t y);
00050         void putPixel(int32_t x, int32_t y, const gcn::Color& color);
00051         void convertToDisplayFormat();
00052         ImagePtr getFIFEImage() const { return m_imgPtr; }
00053     protected:
00054         ImagePtr m_imgPtr;
00055     };
00056 }
00057 
00058 #endif