OpenTTD
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 {
27 };
28 
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,
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);
114 };
115 
117 struct CursorVars {
118  /* Logical mouse position */
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];
133  Point total_offs, total_size;
134 
135  Point draw_pos, draw_size;
136 
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 
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 {
208  FS_END,
209 
211 };
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 
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 
271  TC_NO_SHADE = 0x200,
272 };
274 
275 
279 };
280 
286 };
287 
293  MAX_PAL = 2,
294 };
295 
298  ST_NORMAL = 0,
299  ST_MAPGEN = 1,
300  ST_FONT = 2,
303 };
304 
306 static const uint MILLISECONDS_PER_TICK = 30;
307 
309 struct Palette {
310  Colour palette[256];
313 };
314 
320 };
321 
322 #endif /* GFX_TYPE_H */
Helper template class that makes basic properties of given enumeration type visible from outsize...
Definition: enum_type.hpp:66
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition of various endian-dependant macros.
bool dirty
the rect occupied by the mouse is dirty (redraw)
Definition: gfx_type.h:142
Data about how and where to blit pixels.
Definition: gfx_type.h:156
Point pos
logical mouse position
Definition: gfx_type.h:119
Information about the currently used palette.
Definition: gfx_type.h:309
WindowKeyCodes
Definition: gfx_type.h:29
bool vehchain
vehicle chain is dragged
Definition: gfx_type.h:146
, Comma
Definition: gfx_type.h:104
uint sprite_count
number of sprites to draw
Definition: gfx_type.h:132
Index of the monospaced font in the font tables.
Definition: gfx_type.h:207
uint32 data
Conversion of the channel information to a 32 bit number.
Definition: gfx_type.h:165
uint8 a
colour channels in LE order
Definition: gfx_type.h:170
= Equals
Definition: gfx_type.h:99
Combination of a palette sprite and a &#39;real&#39; sprite.
Definition: gfx_type.h:24
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition: gfx_type.h:137
Use the Windows palette.
Definition: gfx_type.h:291
Use the DOS palette.
Definition: gfx_type.h:290
The most basic (normal) sprite.
Definition: gfx_type.h:298
No 8bpp support by hardware, do not try to use 8bpp video modes or hardware palettes.
Definition: gfx_type.h:318
bool visible
cursor is visible
Definition: gfx_type.h:141
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:282
Point total_size
union of sprite properties
Definition: gfx_type.h:133
Types related to zooming in and out.
Point draw_size
position and size bounding-box for drawing
Definition: gfx_type.h:135
CursorID sprite
Must be set to LAST_ANIM when it is the last sprite of the loop.
Definition: gfx_type.h:112
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:117
&#39; Single quote
Definition: gfx_type.h:103
PaletteAnimationSizes
Defines a few values that are related to animations using palette changes.
Definition: gfx_type.h:276
Fill rectangle with a single colour.
Definition: gfx_type.h:283
First font.
Definition: gfx_type.h:210
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:297
[ Left square bracket
Definition: gfx_type.h:100
] Right square bracket
Definition: gfx_type.h:102
Special sprite for the map generator.
Definition: gfx_type.h:299
Apply a recolour sprite to the screen content.
Definition: gfx_type.h:285
\ Backslash
Definition: gfx_type.h:101
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
int wheel
mouse wheel movement
Definition: gfx_type.h:121
Informative template class exposing basic enumeration properties used by several other templates belo...
Definition: enum_type.hpp:52
/ Forward slash
Definition: gfx_type.h:97
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
Definition: gfx_type.h:306
number of animated colours
Definition: gfx_type.h:277
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:122
A single sprite of a list of animated cursors.
Definition: gfx_type.h:110
byte display_time
Amount of ticks this sprite will be shown.
Definition: gfx_type.h:113
Colour(uint data=0)
Create a new colour.
Definition: gfx_type.h:194
#define MAX_UVALUE(type)
The largest value that can be entered in a variable.
Definition: stdafx.h:515
int first_dirty
The first dirty element.
Definition: gfx_type.h:311
Pseudosprite or other unusable sprite, used only internally.
Definition: gfx_type.h:302
#define TTD_BIG_ENDIAN
Big endian builds use this for TTD_ENDIAN.
Definition: endian_type.hpp:26
; Semicolon
Definition: gfx_type.h:98
Automatically detect the palette based on the graphics pack.
Definition: gfx_type.h:292
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:284
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
No support for 8bpp by OS or hardware, force 32bpp blitters.
Definition: gfx_type.h:317
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
uint animate_timeout
in case of animated cursor, number of ticks to show the current cursor
Definition: gfx_type.h:139
Colour(uint8 r, uint8 g, uint8 b, uint8 a=0xFF)
Create a new colour.
Definition: gfx_type.h:181
The number of palettes.
Definition: gfx_type.h:293
Do not add shading to this text colour.
Definition: gfx_type.h:271
FontSize
Available font sizes.
Definition: gfx_type.h:203
PaletteType
Palettes OpenTTD supports.
Definition: gfx_type.h:289
Index of the normal font in the font tables.
Definition: gfx_type.h:204
All geometry types in OpenTTD.
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:143
Used to only draw a part of the sprite.
Definition: gfx_type.h:219
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:21
Coordinates of a point in 2D.
Structure to access the alpha, red, green, and blue channels from a 32 bit number.
Definition: gfx_type.h:164
Index of the small font in the font tables.
Definition: gfx_type.h:205
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:270
Index of the large font in the font tables.
Definition: gfx_type.h:206
. Period
Definition: gfx_type.h:105
Support8bpp
Modes for 8bpp support.
Definition: gfx_type.h:316
Recolour sprite.
Definition: gfx_type.h:301
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:120
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition: gfx_type.h:138
#define DECLARE_POSTFIX_INCREMENT(type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:16
SpriteID sprite
The &#39;real&#39; sprite.
Definition: gfx_type.h:25
int count_dirty
The number of dirty elements.
Definition: gfx_type.h:312
Index in the _palettes array from which all animations are taking places (table/palettes.h)
Definition: gfx_type.h:278
Fake keycode bit to indicate global hotkeys.
Definition: gfx_type.h:35
Full 8bpp support by OS and hardware.
Definition: gfx_type.h:319
A sprite used for fonts.
Definition: gfx_type.h:300
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:26