include/iimage.h

   1 /*
   2 Copyright (C) 2001-2006, William Joseph.
   3 All Rights Reserved.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #if !defined(INCLUDED_IIMAGE_H)
  23 #define INCLUDED_IIMAGE_H
  24
  25 #include "generic/constant.h"
  26
  27 typedef unsigned char byte;
  28
  29 class Image
  30 {
  31 public:
  32   virtual void release() = 0;
  33   virtual byte* getRGBAPixels() const = 0;
  34   virtual unsigned int getWidth() const = 0;
  35   virtual unsigned int getHeight() const = 0;
  36
  37   virtual int getSurfaceFlags() const
  38   {
  39     return 0;
  40   }
  41   virtual int getContentFlags() const
  42   {
  43     return 0;
  44   }
  45   virtual int getValue() const
  46   {
  47     return 0;
  48   }
  49 };
  50
  51 class ArchiveFile;
  52
  53 struct _QERPlugImageTable
  54 {
  55   INTEGER_CONSTANT(Version, 1);
  56   STRING_CONSTANT(Name, "image");
  57
  58   /// Read an image from the file.
  59   /// Returns 0 if the image could not be read.
  60   Image* (*loadImage)(ArchiveFile& file);
  61 };
  62
  63 template<typename Type>
  64 class ModuleRef;
  65 typedef ModuleRef<_QERPlugImageTable> ImageModuleRef;
  66
  67 template<typename Type>
  68 class Modules;
  69 typedef Modules<_QERPlugImageTable> ImageModules;
  70
  71 template<typename Type>
  72 class ModulesRef;
  73 typedef ModulesRef<_QERPlugImageTable> ImageModulesRef;
  74
  75 #endif // _IIMAGE_H