gemrb/core/PalettedImageMgr.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  */
  18
  19 #ifndef PALETTEDIMAGEMGR_H
  20 #define PALETTEDIMAGEMGR_H
  21
  22 #include "Resource.h"
  23 #include "Sprite2D.h"
  24 #include "System/DataStream.h"
  25
  26 class ImageFactory;
  27
  28 /**
  29  * Base class for Paletted Imqge plugins
  30  *
  31  * This represents a false color image that is combined with
  32  * color data to generate a real image.
  33  */
  34 class GEM_EXPORT PalettedImageMgr : public Resource {
  35 public:
  36         static const TypeID ID;
  37 public:
  38         PalettedImageMgr(void);
  39         virtual ~PalettedImageMgr(void);
  40         /**
  41          * Returns a @ref{Sprite2D} that has been colored with the given palette.
  42          *
  43          * @param[in] type Type of palette to use.
  44          * @param[in] paletteIndex Array of palettes to use.
  45          */
  46         virtual Sprite2D* GetSprite2D(unsigned int type, ieDword paletteIndex[8]) = 0;
  47 };
  48
  49 #endif