Merge remote-tracking branch 'illwieckz/pakpath'
[xonotic/netradiant.git] / 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         return 0;
39 }
40 virtual int getContentFlags() const {
41         return 0;
42 }
43 virtual int getValue() const {
44         return 0;
45 }
46 };
47
48 class ArchiveFile;
49
50 struct _QERPlugImageTable
51 {
52         INTEGER_CONSTANT( Version, 1 );
53         STRING_CONSTANT( Name, "image" );
54
55         /// Read an image from the file.
56         /// Returns 0 if the image could not be read.
57         Image* ( *loadImage )( ArchiveFile & file );
58 };
59
60 template<typename Type>
61 class ModuleRef;
62 typedef ModuleRef<_QERPlugImageTable> ImageModuleRef;
63
64 template<typename Type>
65 class Modules;
66 typedef Modules<_QERPlugImageTable> ImageModules;
67
68 template<typename Type>
69 class ModulesRef;
70 typedef ModulesRef<_QERPlugImageTable> ImageModulesRef;
71
72 #endif // _IIMAGE_H