1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004, 2005, 2006, 2007 Olof Naessn and Per Larsson
*
* Js_./
* Per Larsson a.k.a finalman _RqZ{a<^_aa
* Olof Naessn a.k.a jansem/yakslem _asww7!uY`> )\a//
* _Qhm`] _f "'c 1!5m
* Visit: http://guichan.darkbits.org )Qk<P ` _: :+' .' "{[
* .)j(] .d_/ '-( P . S
* License: (BSD) <Td/Z <fP"5(\"??"\a. .L
* Redistribution and use in source and _dV>ws?a-?' ._/L #'
* binary forms, with or without )4d[#7r, . ' )d`)[
* modification, are permitted provided _Q-5'5W..j/?' -?!\)cam'
* that the following conditions are met: j<<WP+k/);. _W=j f
* 1. Redistributions of source code must .$%w\/]Q . ."' . mj$
* retain the above copyright notice, ]E.pYY(Q]>. a J@\
* this list of conditions and the j(]1u<sE"L,. . ./^ ]{a
* following disclaimer. 4'_uomm\. )L);-4 (3=
* 2. Redistributions in binary form must )_]X{Z('a_"a7'<a"a, ]"[
* reproduce the above copyright notice, #}<]m7`Za??4,P-"'7. ).m
* this list of conditions and the ]d2e)Q(<Q( ?94 b- LQ/
* following disclaimer in the <B!</]C)d_, '(<' .f. =C+m
* documentation and/or other materials .Z!=J ]e []('-4f _ ) -.)m]'
* provided with the distribution. .w[5]' _[ /.)_-"+? _/ <W"
* 3. Neither the name of Guichan nor the :$we` _! + _/ . j?
* names of its contributors may be used =3)= _f (_yQmWW$#( "
* to endorse or promote products derived - W, sQQQQmZQ#Wwa]..
* from this software without specific (js, \[QQW$QWW#?!V"".
* prior written permission. ]y:.<\.. .
* -]n w/ ' [.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT )/ )/ !
* HOLDERS AND CONTRIBUTORS "AS IS" AND ANY < (; sac , '
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, ]^ .- %
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF c < r
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR aga< <La
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 5% )P'-3L
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR _bQf` y`..)a
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, ,J?4P'.P"_(\?d'.,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES _Pa,)!f/<[]/ ?"
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT _2-..:. .r+_,.. .
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ?a.<%"' " -'.a_ _,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ^
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_IMAGE_HPP
#define GCN_IMAGE_HPP
#include <string>
#include "guichan/platform.hpp"
namespace gcn
{
class Color;
class ImageLoader;
/**
* Holds an image. To be able to use this class you must first set an
* ImageLoader in Image by calling
* @code Image::setImageLoader(myImageLoader) @endcode
* The function is static. If this is not done, the constructor taking a
* filename will throw an exception. The ImageLoader you use must be
* compatible with the Graphics object you use.
*
* EXAMPLE: If you use SDLGraphics you should use SDLImageLoader.
* Otherwise your program will crash in a most bizarre way.
*/
class GCN_CORE_DECLSPEC Image
{
public:
/**
* Constructor.
*/
Image();
/**
* Destructor.
*/
virtual ~Image();
/**
* Loads an image by calling the Image class' ImageLoader.
*
* NOTE: The functions getPixel and putPixel are only guaranteed to work
* before an image has been converted to display format.
*
* @param filename the file to load.
* @param convertToDisplayFormat true if the image should be converted
* to display, false otherwise.
*/
static Image* load(const std::string& filename, bool convertToDisplayFormat = true);
/**
* Gets the ImageLoader used for loading Images.
*
* @return the ImageLoader used for loading Images.
* @see SDLImageLoader, AllegroImageLoader
*/
static ImageLoader* getImageLoader();
/**
* Sets the ImageLoader to be used for loading images.
*
* IMPORTANT: The ImageLoader is static and MUST be set before loading
* images!
*
* @param imageLoader the ImageLoader to be used for loading images.
* @see SDLImageLoader, AllegroImageLoader
*/
static void setImageLoader(ImageLoader* imageLoader);
/**
* Frees an image.
*/
virtual void free() = 0;
/**
* Gets the width of the Image.
*
* @return the image width
*/
virtual int getWidth() const = 0;
/**
* Gets the height of the Image.
*
* @return the image height
*/
virtual int getHeight() const = 0;
/**
* Gets the color of a pixel at coordinate (x, y) in the image.
*
* IMPORTANT: Only guaranteed to work before the image has been
* converted to display format.
*
* @param x the x coordinate.
* @param y the y coordinate.
* @return the color of the pixel.
*/
virtual Color getPixel(int x, int y) = 0;
/**
* Puts a pixel with a certain color at coordinate (x, y).
*
* @param x the x coordinate.
* @param y the y coordinate.
* @param color the color of the pixel to put.
*/
virtual void putPixel(int x, int y, const Color& color) = 0;
/**
* Converts the image, if possible, to display format.
*
* IMPORTANT: Only guaranteed to work before the image has been
* converted to display format.
*/
virtual void convertToDisplayFormat() = 0;
protected:
static ImageLoader* mImageLoader;
};
}
#endif // end GCN_IMAGE_HPP
|