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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* The Mana World is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMW_IMAGE_H
#define _TMW_IMAGE_H
#include "resource.h"
#include <SDL.h>
#ifdef USE_OPENGL
#include <SDL_opengl.h>
#endif
#include <string>
// This flag causes image alpha channel to be preserved, otherwise masking is
// used.
#define IMG_ALPHA 1
// Forward declarations
class SubImage;
class ScaledImage;
/**
* Defines a class for loading and storing images.
*/
class Image : public Resource
{
public:
/**
* Destructor.
*/
virtual ~Image();
/**
* Loads an image from a buffer in memory.
*
* @param buffer The memory buffer containing the image data.
* @param bufferSize The size of the memory buffer in bytes.
* @param flags These flags allow controlling the way the image is
* loaded. Currently only IMG_ALPHA is supported, which
* causes alpha layer to be preserved.
*
* @return <code>NULL</code> if the an error occurred, a valid pointer
* otherwise.
*/
static Image *load(void* buffer, unsigned int bufferSize, int flags);
/**
* Frees the resources created by SDL.
*/
virtual void unload();
/**
* Returns the width of the image.
*/
virtual int getWidth() const;
/**
* Returns the height of the image.
*/
virtual int getHeight() const;
/**
* Creates a new image with the desired clipping rectangle.
*
* @return <code>NULL</code> if creation failed and a valid
* object otherwise.
*/
virtual Image* getSubImage(int x, int y, int width, int height);
/**
* Blits the image onto the screen.
*
* @return <code>true</code> if the image was blitted properly
* <code>false</code> otherwise.
*/
virtual bool draw(SDL_Surface *screen,
int srcX, int srcY,
int dstX, int dstY,
int width, int height);
/**
* Blits the image onto the screen.
*
* @return <code>true</code> if the image was blitted properly
* <code>false</code> otherwise.
*/
virtual bool draw(SDL_Surface *screen, int x, int y);
/**
* Does a pattern fill on the given area.
*/
virtual void drawPattern(
SDL_Surface *screen, int x, int y, int w, int h);
/**
* Sets the alpha value of this image.
*/
void setAlpha(float alpha);
/**
* Returns the alpha value of this image.
*/
float getAlpha();
protected:
/**
* Constructor.
*/
#ifdef USE_OPENGL
Image(GLuint image,
int width, int height,
int texWidth, int texHeight);
#else
Image(SDL_Surface *image);
#endif
#ifdef USE_OPENGL
GLuint image;
int width, height;
int texWidth, texHeight;
#else
SDL_Surface *image;
#endif
float alpha;
};
/**
* A clipped version of a larger image.
*/
class SubImage : public Image
{
public:
/**
* Constructor.
*/
#ifndef USE_OPENGL
SubImage(Image *parent, SDL_Surface *image,
int x, int y, int width, int height);
#else
SubImage(Image *parent, GLuint image, int x, int y,
int width, int height, int texWidth, int textHeight);
#endif
/**
* Destructor.
*/
~SubImage();
/**
* Returns the width of the image.
*/
int getWidth() const;
/**
* Returns the height of the image.
*/
int getHeight() const;
/**
* Creates a new image with the desired clipping rectangle.
* @return <code>NULL</code> if creation failed and a valid
* object otherwise.
*/
Image* getSubImage(int x, int y, int width, int height);
/**
* Draws this image.
*/
bool draw(SDL_Surface *screen, int srcX, int srcY,
int dstX, int dstY, int width, int height);
/**
* Draws the clipped image onto the screen.
* @return <code>true</code> if drawing was succesful
* <code>false</code> otherwise.
*/
bool draw(SDL_Surface *screen, int x, int y);
private:
Image *parent;
SDL_Rect rect;
};
#endif
|
