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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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 (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*/
#ifndef GRAPHICS_SURFACE_H
#define GRAPHICS_SURFACE_H
#include "common/scummsys.h"
#include "common/rect.h"
namespace Graphics {
/**
* An arbitrary graphics surface, which can be the target (or source) of blit
* operations, font rendering, etc.
*/
struct Surface {
/*
* IMPORTANT implementation specific detail:
*
* ARM code relies on the layout of the first 3 of these fields. Do not
* change them.
*/
/**
* The width of the surface.
*/
uint16 w;
/**
* The height of the surface.
*/
uint16 h;
/**
* The number of bytes a pixel line has.
*
* Note that this might not equal w * bytesPerPixel.
*/
uint16 pitch;
/**
* The surface's pixel data.
*/
void *pixels;
/**
* How many bytes a single pixel occupies.
*/
uint8 bytesPerPixel;
/**
* Construct a simple Surface object.
*/
Surface() : w(0), h(0), pitch(0), pixels(0), bytesPerPixel(0) {
}
/**
* Return a pointer to the pixel at the specified point.
*
* @param x The x coordinate of the pixel.
* @param y The y coordinate of the pixel.
* @return Pointer to the pixel.
*/
inline const void *getBasePtr(int x, int y) const {
return (const byte *)(pixels) + y * pitch + x * bytesPerPixel;
}
/**
* Return a pointer to the pixel at the specified point.
*
* @param x The x coordinate of the pixel.
* @param y The y coordinate of the pixel.
* @return Pointer to the pixel.
*/
inline void *getBasePtr(int x, int y) {
return static_cast<byte *>(pixels) + y * pitch + x * bytesPerPixel;
}
/**
* Allocate memory for the pixel data of the surface.
*
* Note that you are responsible for calling free yourself.
* @see free
*
* @param width Width of the surface object.
* @param height Height of the surface object.
* @param bytePP The number of bytes a single pixel uses.
*/
void create(uint16 width, uint16 height, uint8 bytesPP);
/**
* Release the memory used by the pixels memory of this surface. This is the
* counterpart to create().
*
* Note that you should only use this, when you created the Surface data via
* create! Otherwise this function has undefined behavior.
* @see create
*/
void free();
/**
* Copy the data from another Surface.
*
* Note that this calls free on the current surface, to assure it being
* clean. So be sure the current data was created via create, otherwise
* the results are undefined.
* @see create
* @see free
*
* @param surf Surface to copy from.
*/
void copyFrom(const Surface &surf);
/**
* Draw a line.
*
* @param x0 The x coordinate of the start point.
* @param y0 The y coordiante of the start point.
* @param x1 The x coordinate of the end point.
* @param y1 The y coordinate of the end point.
* @param color The color of the line.
*/
void drawLine(int x0, int y0, int x1, int y1, uint32 color);
/**
* Draw a horizontal line.
*
* @param x The start x coordinate of the line.
* @param y The y coordiante of the line.
* @param x2 The end x coordinate of the line.
* In case x > x2 the coordinates are swapped.
* @param color The color of the line.
*/
void hLine(int x, int y, int x2, uint32 color);
/**
* Draw a vertical line.
*
* @param x The x coordinate of the line.
* @param y The start y coordiante of the line.
* @param y2 The end y coordinate of the line.
* In case y > y2 the coordinates are swapped.
* @param color The color of the line.
*/
void vLine(int x, int y, int y2, uint32 color);
/**
* Fill a rect with a given color.
*
* @param r Rect to fill
* @param color The color of the rect's contents.
*/
void fillRect(Common::Rect r, uint32 color);
/**
* Draw a frame around a specified rect.
*
* @param r Rect to frame
* @param color The color of the frame.
*/
void frameRect(const Common::Rect &r, uint32 color);
// See comment in graphics/surface.cpp about it
void move(int dx, int dy, int height);
};
/**
* A deleter for Surface objects which can be used with SharedPtr.
*
* This deleter assures Surface::free is called on deletion.
*/
struct SharedPtrSurfaceDeleter {
void operator()(Surface *ptr) {
ptr->free();
delete ptr;
}
};
} // End of namespace Graphics
#endif
|
