OpenTTD: src/gfx_type.h Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

gfx_type.h
Go to the documentation of this file.
1 /* $Id: gfx_type.h 27628 2016-08-15 18:33:08Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef GFX_TYPE_H
13 #define GFX_TYPE_H
14
15 #include "core/endian_type.hpp"
16 #include "core/geometry_type.hpp"
17 #include "zoom_type.h"
18
19 typedef uint32 SpriteID;
20 typedef uint32 PaletteID;
21 typedef uint32 CursorID;
22
24 struct PalSpriteID {
25 SpriteID sprite;
26 PaletteID pal;
27 };
28
29 enum WindowKeyCodes {
30 WKC_SHIFT = 0x8000,
31 WKC_CTRL = 0x4000,
32 WKC_ALT = 0x2000,
33 WKC_META = 0x1000,
34
35 WKC_GLOBAL_HOTKEY = 0x0800,
36
37 WKC_SPECIAL_KEYS = WKC_SHIFT | WKC_CTRL | WKC_ALT | WKC_META | WKC_GLOBAL_HOTKEY,
38
39 /* Special ones */
40 WKC_NONE = 0,
41 WKC_ESC = 1,
42 WKC_BACKSPACE = 2,
43 WKC_INSERT = 3,
44 WKC_DELETE = 4,
45
46 WKC_PAGEUP = 5,
47 WKC_PAGEDOWN = 6,
48 WKC_END = 7,
49 WKC_HOME = 8,
50
51 /* Arrow keys */
52 WKC_LEFT = 9,
53 WKC_UP = 10,
54 WKC_RIGHT = 11,
55 WKC_DOWN = 12,
56
57 /* Return & tab */
58 WKC_RETURN = 13,
59 WKC_TAB = 14,
60
61 /* Space */
62 WKC_SPACE = 32,
63
64 /* Function keys */
65 WKC_F1 = 33,
66 WKC_F2 = 34,
67 WKC_F3 = 35,
68 WKC_F4 = 36,
69 WKC_F5 = 37,
70 WKC_F6 = 38,
71 WKC_F7 = 39,
72 WKC_F8 = 40,
73 WKC_F9 = 41,
74 WKC_F10 = 42,
75 WKC_F11 = 43,
76 WKC_F12 = 44,
77
78 /* Backquote is the key left of "1"
79 * we only store this key here, no matter what character is really mapped to it
80 * on a particular keyboard. (US keyboard: ` and ~ ; German keyboard: ^ and °) */
81 WKC_BACKQUOTE = 45,
82 WKC_PAUSE = 46,
83
84 /* 0-9 are mapped to 48-57
85 * A-Z are mapped to 65-90
86 * a-z are mapped to 97-122 */
87
88 /* Numerical keyboard */
89 WKC_NUM_DIV = 138,
90 WKC_NUM_MUL = 139,
91 WKC_NUM_MINUS = 140,
92 WKC_NUM_PLUS = 141,
93 WKC_NUM_ENTER = 142,
94 WKC_NUM_DECIMAL = 143,
95
96 /* Other keys */
97 WKC_SLASH = 144,
98 WKC_SEMICOLON = 145,
99 WKC_EQUALS = 146,
100 WKC_L_BRACKET = 147,
101 WKC_BACKSLASH = 148,
102 WKC_R_BRACKET = 149,
103 WKC_SINGLEQUOTE = 150,
104 WKC_COMMA = 151,
105 WKC_PERIOD = 152,
106 WKC_MINUS = 153,
107 };
108
110 struct AnimCursor {
111 static const CursorID LAST = MAX_UVALUE(CursorID);
112 CursorID sprite;
113 byte display_time;
114 };
115
117 struct CursorVars {
118 /* Logical mouse position */
119 Point pos;
120 Point delta;
121 int wheel;
122 bool fix_at;
123
124 /* We need two different vars to keep track of how far the scrollwheel moved.
125 * OSX uses this for scrolling around the map. */
126 int v_wheel;
127 int h_wheel;
128
129 /* Mouse appearance */
130 PalSpriteID sprite_seq[16];
131 Point sprite_pos[16];
132 uint sprite_count;
133 Point total_offs, total_size;
134
135 Point draw_pos, draw_size;
136
137 const AnimCursor *animate_list;
138 const AnimCursor *animate_cur;
139 uint animate_timeout;
140
141 bool visible;
142 bool dirty;
143 bool in_window;
144
145 /* Drag data */
146 bool vehchain;
147
148 bool UpdateCursorPosition(int x, int y, bool queued_warp);
149
150 private:
151 bool queued_warp;
152 Point last_position;
153 };
154
156 struct DrawPixelInfo {
157 void *dst_ptr;
158 int left, top, width, height;
159 int pitch;
160 ZoomLevel zoom;
161 };
162
164 union Colour {
165 uint32 data;
166 struct {
167 #if TTD_ENDIAN == TTD_BIG_ENDIAN
168 uint8 a, r, g, b;
169 #else
170 uint8 b, g, r, a;
171 #endif /* TTD_ENDIAN == TTD_BIG_ENDIAN */
172 };
173
181 Colour(uint8 r, uint8 g, uint8 b, uint8 a = 0xFF) :
182 #if TTD_ENDIAN == TTD_BIG_ENDIAN
183 a(a), r(r), g(g), b(b)
184 #else
185 b(b), g(g), r(r), a(a)
186 #endif /* TTD_ENDIAN == TTD_BIG_ENDIAN */
187 {
188 }
189
194 Colour(uint data = 0) : data(data)
195 {
196 }
197 };
198
199 assert_compile(sizeof(Colour) == sizeof(uint32));
200
201
203 enum FontSize {
204 FS_NORMAL,
205 FS_SMALL,
206 FS_LARGE,
207 FS_MONO,
208 FS_END,
209
210 FS_BEGIN = FS_NORMAL,
211 };
212 DECLARE_POSTFIX_INCREMENT(FontSize)
213
214
219 struct SubSprite {
220 int left, top, right, bottom;
221 };
222
223 enum Colours {
224 COLOUR_BEGIN,
225 COLOUR_DARK_BLUE = COLOUR_BEGIN,
226 COLOUR_PALE_GREEN,
227 COLOUR_PINK,
228 COLOUR_YELLOW,
229 COLOUR_RED,
230 COLOUR_LIGHT_BLUE,
231 COLOUR_GREEN,
232 COLOUR_DARK_GREEN,
233 COLOUR_BLUE,
234 COLOUR_CREAM,
235 COLOUR_MAUVE,
236 COLOUR_PURPLE,
237 COLOUR_ORANGE,
238 COLOUR_BROWN,
239 COLOUR_GREY,
240 COLOUR_WHITE,
241 COLOUR_END,
242 INVALID_COLOUR = 0xFF,
243 };
244 template <> struct EnumPropsT<Colours> : MakeEnumPropsT<Colours, byte, COLOUR_BEGIN, COLOUR_END, INVALID_COLOUR, 4> {};
245
247 enum TextColour {
248 TC_BEGIN = 0x00,
249 TC_FROMSTRING = 0x00,
250 TC_BLUE = 0x00,
251 TC_SILVER = 0x01,
252 TC_GOLD = 0x02,
253 TC_RED = 0x03,
254 TC_PURPLE = 0x04,
255 TC_LIGHT_BROWN = 0x05,
256 TC_ORANGE = 0x06,
257 TC_GREEN = 0x07,
258 TC_YELLOW = 0x08,
259 TC_DARK_GREEN = 0x09,
260 TC_CREAM = 0x0A,
261 TC_BROWN = 0x0B,
262 TC_WHITE = 0x0C,
263 TC_LIGHT_BLUE = 0x0D,
264 TC_GREY = 0x0E,
265 TC_DARK_BLUE = 0x0F,
266 TC_BLACK = 0x10,
267 TC_END,
268 TC_INVALID = 0xFF,
269
270 TC_IS_PALETTE_COLOUR = 0x100,
271 TC_NO_SHADE = 0x200,
272 };
273 DECLARE_ENUM_AS_BIT_SET(TextColour)
274
275
276 enum PaletteAnimationSizes {
277 PALETTE_ANIM_SIZE = 28,
278 PALETTE_ANIM_START = 227,
279 };
280
282 enum FillRectMode {
283 FILLRECT_OPAQUE,
284 FILLRECT_CHECKER,
285 FILLRECT_RECOLOUR,
286 };
287
289 enum PaletteType {
290 PAL_DOS,
291 PAL_WINDOWS,
292 PAL_AUTODETECT,
293 MAX_PAL = 2,
294 };
295
297 enum SpriteType {
298 ST_NORMAL = 0,
299 ST_MAPGEN = 1,
300 ST_FONT = 2,
301 ST_RECOLOUR = 3,
302 ST_INVALID = 4,
303 };
304
306 static const uint MILLISECONDS_PER_TICK = 30;
307
309 struct Palette {
310 Colour palette[256];
311 int first_dirty;
312 int count_dirty;
313 };
314
316 enum Support8bpp {
317 S8BPP_NONE = 0,
318 S8BPP_SYSTEM,
319 S8BPP_HARDWARE,
320 };
321
322 #endif /* GFX_TYPE_H */