OpenTTD Source 20250205-master-gfd85ab1e2c
gfx_type.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10#ifndef GFX_TYPE_H
11#define GFX_TYPE_H
12
13#include "core/enum_type.hpp"
15#include "zoom_type.h"
16
17typedef uint32_t SpriteID;
18typedef uint32_t PaletteID;
19typedef uint32_t CursorID;
20
26
27enum WindowKeyCodes : uint16_t {
28 WKC_SHIFT = 0x8000,
29 WKC_CTRL = 0x4000,
30 WKC_ALT = 0x2000,
31 WKC_META = 0x1000,
32
34
35 WKC_SPECIAL_KEYS = WKC_SHIFT | WKC_CTRL | WKC_ALT | WKC_META | WKC_GLOBAL_HOTKEY,
36
37 /* Special ones */
38 WKC_NONE = 0,
39 WKC_ESC = 1,
40 WKC_BACKSPACE = 2,
41 WKC_INSERT = 3,
42 WKC_DELETE = 4,
43
44 WKC_PAGEUP = 5,
45 WKC_PAGEDOWN = 6,
46 WKC_END = 7,
47 WKC_HOME = 8,
48
49 /* Arrow keys */
50 WKC_LEFT = 9,
51 WKC_UP = 10,
52 WKC_RIGHT = 11,
53 WKC_DOWN = 12,
54
55 /* Return & tab */
56 WKC_RETURN = 13,
57 WKC_TAB = 14,
58
59 /* Space */
60 WKC_SPACE = 32,
61
62 /* Function keys */
63 WKC_F1 = 33,
64 WKC_F2 = 34,
65 WKC_F3 = 35,
66 WKC_F4 = 36,
67 WKC_F5 = 37,
68 WKC_F6 = 38,
69 WKC_F7 = 39,
70 WKC_F8 = 40,
71 WKC_F9 = 41,
72 WKC_F10 = 42,
73 WKC_F11 = 43,
74 WKC_F12 = 44,
75
76 /* Backquote is the key left of "1"
77 * we only store this key here, no matter what character is really mapped to it
78 * on a particular keyboard. (US keyboard: ` and ~ ; German keyboard: ^ and °) */
79 WKC_BACKQUOTE = 45,
80 WKC_PAUSE = 46,
81
82 /* 0-9 are mapped to 48-57
83 * A-Z are mapped to 65-90
84 * a-z are mapped to 97-122 */
85
86 /* Numerical keyboard */
87 WKC_NUM_DIV = 138,
88 WKC_NUM_MUL = 139,
89 WKC_NUM_MINUS = 140,
90 WKC_NUM_PLUS = 141,
91 WKC_NUM_ENTER = 142,
92 WKC_NUM_DECIMAL = 143,
93
94 /* Other keys */
95 WKC_SLASH = 144,
97 WKC_EQUALS = 146,
102 WKC_COMMA = 151,
104 WKC_MINUS = 153,
105};
106
109 static const CursorID LAST = std::numeric_limits<CursorID>::max();
111 uint8_t display_time;
112};
113
117
118 constexpr CursorSprite(SpriteID spr, PaletteID pal, int x, int y) : image({spr, pal}), pos({x, y}) {}
119};
120
123 /* Logical mouse position */
126 int wheel;
127 bool fix_at;
128
129 /* 2D wheel scrolling for moving around the map */
130 bool wheel_moved;
131 float v_wheel;
132 float h_wheel;
133
134 /* Mouse appearance */
135 std::vector<CursorSprite> sprites;
136 Point total_offs, total_size;
137
138 Point draw_pos, draw_size;
139
143
144 bool visible;
145 bool dirty;
147
148 /* Drag data */
149 bool vehchain;
150
151 void UpdateCursorPositionRelative(int delta_x, int delta_y);
152 bool UpdateCursorPosition(int x, int y);
153};
154
157 void *dst_ptr;
158 int left, top, width, height;
159 int pitch;
160 ZoomLevel zoom;
161};
162
165 uint32_t data;
166 struct {
167 uint8_t r, g, b, a;
168 };
169
177 constexpr ColourRGBA(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 0xFF) : r(r), g(g), b(b), a(a) { }
178
183 constexpr ColourRGBA(uint data = 0) : data(data) { }
184};
185
188 uint32_t data;
189 struct {
190 uint8_t a, r, g, b;
191 };
192
200 constexpr ColourARGB(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 0xFF) : a(a), r(r), g(g), b(b) { }
201
206 constexpr ColourARGB(uint data = 0) : data(data) { }
207};
208
211 uint32_t data;
212 struct {
213 uint8_t b, g, r, a;
214 };
215
223 constexpr ColourBGRA(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 0xFF) : b(b), g(g), r(r), a(a) { }
224
229 constexpr ColourBGRA(uint data = 0) : data(data) { }
230};
231
232#if defined(__EMSCRIPTEN__)
233using Colour = ColourRGBA;
234#else
235using Colour = std::conditional_t<std::endian::native == std::endian::little, ColourBGRA, ColourARGB>;
236#endif /* defined(__EMSCRIPTEN__) */
237
238static_assert(sizeof(Colour) == sizeof(uint32_t));
239
240
252
253inline const char *FontSizeToName(FontSize fs)
254{
255 static const char *SIZE_TO_NAME[] = { "medium", "small", "large", "mono" };
256 assert(fs < FS_END);
257 return SIZE_TO_NAME[fs];
258}
259
265struct SubSprite {
266 int left, top, right, bottom;
267};
268
269enum Colours : uint8_t {
270 COLOUR_BEGIN,
271 COLOUR_DARK_BLUE = COLOUR_BEGIN,
272 COLOUR_PALE_GREEN,
273 COLOUR_PINK,
274 COLOUR_YELLOW,
275 COLOUR_RED,
276 COLOUR_LIGHT_BLUE,
277 COLOUR_GREEN,
278 COLOUR_DARK_GREEN,
279 COLOUR_BLUE,
280 COLOUR_CREAM,
281 COLOUR_MAUVE,
282 COLOUR_PURPLE,
283 COLOUR_ORANGE,
284 COLOUR_BROWN,
285 COLOUR_GREY,
286 COLOUR_WHITE,
287 COLOUR_END,
288 INVALID_COLOUR = 0xFF,
289};
292
293
294enum TextColour : uint16_t {
295 TC_BEGIN = 0x00,
296 TC_FROMSTRING = 0x00,
297 TC_BLUE = 0x00,
298 TC_SILVER = 0x01,
299 TC_GOLD = 0x02,
300 TC_RED = 0x03,
301 TC_PURPLE = 0x04,
302 TC_LIGHT_BROWN = 0x05,
303 TC_ORANGE = 0x06,
304 TC_GREEN = 0x07,
305 TC_YELLOW = 0x08,
306 TC_DARK_GREEN = 0x09,
307 TC_CREAM = 0x0A,
308 TC_BROWN = 0x0B,
309 TC_WHITE = 0x0C,
310 TC_LIGHT_BLUE = 0x0D,
311 TC_GREY = 0x0E,
312 TC_DARK_BLUE = 0x0F,
313 TC_BLACK = 0x10,
314 TC_END,
315 TC_INVALID = 0xFF,
316
318 TC_NO_SHADE = 0x200,
319 TC_FORCED = 0x400,
320
323};
325
326/* A few values that are related to animations using palette changes */
327static constexpr uint8_t PALETTE_ANIM_SIZE = 28;
328static constexpr uint8_t PALETTE_ANIM_START = 227;
329
336
338enum PaletteType : uint8_t {
341};
342
344enum class SpriteType : uint8_t {
345 Normal = 0,
346 MapGen = 1,
347 Font = 2,
348 Recolour = 3,
349 Invalid = 4,
350};
351
357static const uint MILLISECONDS_PER_TICK = 27;
358
360struct Palette {
361 Colour palette[256];
364};
365
372
374enum StringAlignment : uint8_t {
375 SA_LEFT = 0 << 0,
376 SA_HOR_CENTER = 1 << 0,
377 SA_RIGHT = 2 << 0,
378 SA_HOR_MASK = 3 << 0,
379
380 SA_TOP = 0 << 2,
381 SA_VERT_CENTER = 1 << 2,
382 SA_BOTTOM = 2 << 2,
383 SA_VERT_MASK = 3 << 2,
384
386
387 SA_FORCE = 1 << 4,
388};
390
391#endif /* GFX_TYPE_H */
Container with information about a font.
Definition gfx_layout.h:75
Type (helpers) for enums.
#define DECLARE_ENUM_AS_BIT_SET(enum_type)
Operators to allow to work with enum as with type safe bit set in C++.
Definition enum_type.hpp:68
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition enum_type.hpp:78
#define DECLARE_INCREMENT_DECREMENT_OPERATORS(enum_type)
For some enums it is useful to have pre/post increment/decrement operators.
Definition enum_type.hpp:61
All geometry types in OpenTTD.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
Support8bpp
Modes for 8bpp support.
Definition gfx_type.h:367
@ S8BPP_HARDWARE
Full 8bpp support by OS and hardware.
Definition gfx_type.h:370
@ S8BPP_NONE
No support for 8bpp by OS or hardware, force 32bpp blitters.
Definition gfx_type.h:368
@ S8BPP_SYSTEM
No 8bpp support by hardware, do not try to use 8bpp video modes or hardware palettes.
Definition gfx_type.h:369
SpriteType
Types of sprites that might be loaded.
Definition gfx_type.h:344
@ Recolour
Recolour sprite.
@ MapGen
Special sprite for the map generator.
@ Invalid
Pseudosprite or other unusable sprite, used only internally.
@ Normal
The most basic (normal) sprite.
static constexpr uint8_t PALETTE_ANIM_SIZE
number of animated colours
Definition gfx_type.h:327
FontSize
Available font sizes.
Definition gfx_type.h:242
@ FS_MONO
Index of the monospaced font in the font tables.
Definition gfx_type.h:246
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:244
@ FS_BEGIN
First font.
Definition gfx_type.h:249
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:243
@ FS_LARGE
Index of the large font in the font tables.
Definition gfx_type.h:245
uint32_t CursorID
The number of the cursor (sprite)
Definition gfx_type.h:19
StringAlignment
How to align the to-be drawn text.
Definition gfx_type.h:374
@ SA_TOP
Top align the text.
Definition gfx_type.h:380
@ SA_LEFT
Left align the text.
Definition gfx_type.h:375
@ SA_HOR_MASK
Mask for horizontal alignment.
Definition gfx_type.h:378
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:377
@ SA_HOR_CENTER
Horizontally center the text.
Definition gfx_type.h:376
@ SA_VERT_MASK
Mask for vertical alignment.
Definition gfx_type.h:383
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition gfx_type.h:387
@ SA_BOTTOM
Bottom align the text.
Definition gfx_type.h:382
@ SA_CENTER
Center both horizontally and vertically.
Definition gfx_type.h:385
@ SA_VERT_CENTER
Vertically center the text.
Definition gfx_type.h:381
PaletteType
Palettes OpenTTD supports.
Definition gfx_type.h:338
@ PAL_DOS
Use the DOS palette.
Definition gfx_type.h:339
@ PAL_WINDOWS
Use the Windows palette.
Definition gfx_type.h:340
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
static constexpr uint8_t PALETTE_ANIM_START
Index in the _palettes array from which all animations are taking places (table/palettes....
Definition gfx_type.h:328
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:294
@ TC_FORCED
Ignore colour changes from strings.
Definition gfx_type.h:319
@ TC_FLAGS_MASK
Mask to test if TextColour (with flags) is within limits.
Definition gfx_type.h:322
@ TC_NO_SHADE
Do not add shading to this text colour.
Definition gfx_type.h:318
@ TC_IS_PALETTE_COLOUR
Colour value is already a real palette colour index, not an index of a StringColour.
Definition gfx_type.h:317
@ TC_COLOUR_MASK
Mask to test if TextColour (without flags) is within limits.
Definition gfx_type.h:321
FillRectMode
Define the operation GfxFillRect performs.
Definition gfx_type.h:331
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:333
@ FILLRECT_OPAQUE
Fill rectangle with a single colour.
Definition gfx_type.h:332
@ FILLRECT_RECOLOUR
Apply a recolour sprite to the screen content.
Definition gfx_type.h:334
static const uint MILLISECONDS_PER_TICK
The number of milliseconds per game tick.
Definition gfx_type.h:357
WindowKeyCodes
Definition gfx_type.h:27
@ WKC_BACKSLASH
\ Backslash
Definition gfx_type.h:99
@ WKC_MINUS
Definition gfx_type.h:104
@ WKC_COMMA
, Comma
Definition gfx_type.h:102
@ WKC_PERIOD
. Period
Definition gfx_type.h:103
@ WKC_EQUALS
= Equals
Definition gfx_type.h:97
@ WKC_SLASH
/ Forward slash
Definition gfx_type.h:95
@ WKC_SINGLEQUOTE
' Single quote
Definition gfx_type.h:101
@ WKC_R_BRACKET
] Right square bracket
Definition gfx_type.h:100
@ WKC_L_BRACKET
[ Left square bracket
Definition gfx_type.h:98
@ WKC_GLOBAL_HOTKEY
Fake keycode bit to indicate global hotkeys.
Definition gfx_type.h:33
@ WKC_SEMICOLON
; Semicolon
Definition gfx_type.h:96
A single sprite of a list of animated cursors.
Definition gfx_type.h:108
uint8_t display_time
Amount of ticks this sprite will be shown.
Definition gfx_type.h:111
CursorID sprite
Must be set to LAST_ANIM when it is the last sprite of the loop.
Definition gfx_type.h:110
Point pos
Relative position.
Definition gfx_type.h:116
PalSpriteID image
Image.
Definition gfx_type.h:115
Collection of variables for cursor-display and -animation.
Definition gfx_type.h:122
bool visible
cursor is visible
Definition gfx_type.h:144
bool UpdateCursorPosition(int x, int y)
Update cursor position on mouse movement.
Definition gfx.cpp:1728
uint animate_timeout
in case of animated cursor, number of ticks to show the current cursor
Definition gfx_type.h:142
std::vector< CursorSprite > sprites
Sprites comprising cursor.
Definition gfx_type.h:135
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition gfx_type.h:127
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition gfx_type.h:140
Point pos
logical mouse position
Definition gfx_type.h:124
void UpdateCursorPositionRelative(int delta_x, int delta_y)
Update cursor position based on a relative change.
Definition gfx.cpp:1714
bool vehchain
vehicle chain is dragged
Definition gfx_type.h:149
bool in_window
mouse inside this window, determines drawing logic
Definition gfx_type.h:146
int wheel
mouse wheel movement
Definition gfx_type.h:126
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition gfx_type.h:141
Point total_size
union of sprite properties
Definition gfx_type.h:136
bool dirty
the rect occupied by the mouse is dirty (redraw)
Definition gfx_type.h:145
Point draw_size
position and size bounding-box for drawing
Definition gfx_type.h:138
Point delta
relative mouse movement in this tick
Definition gfx_type.h:125
Data about how and where to blit pixels.
Definition gfx_type.h:156
Combination of a palette sprite and a 'real' sprite.
Definition gfx_type.h:22
SpriteID sprite
The 'real' sprite.
Definition gfx_type.h:23
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition gfx_type.h:24
Information about the currently used palette.
Definition gfx_type.h:360
int first_dirty
The first dirty element.
Definition gfx_type.h:362
int count_dirty
The number of dirty elements.
Definition gfx_type.h:363
Colour palette[256]
Current palette. Entry 0 has to be always fully transparent!
Definition gfx_type.h:361
Coordinates of a point in 2D.
Used to only draw a part of the sprite.
Definition gfx_type.h:265
Packed colour union to access the alpha, red, green, and blue channels from a 32 bit number for big-e...
Definition gfx_type.h:187
uint32_t data
Conversion of the channel information to a 32 bit number.
Definition gfx_type.h:188
constexpr ColourARGB(uint data=0)
Create a new colour.
Definition gfx_type.h:206
constexpr ColourARGB(uint8_t r, uint8_t g, uint8_t b, uint8_t a=0xFF)
Create a new colour.
Definition gfx_type.h:200
uint8_t b
colour channels in BE order
Definition gfx_type.h:190
Packed colour union to access the alpha, red, green, and blue channels from a 32 bit number for littl...
Definition gfx_type.h:210
constexpr ColourBGRA(uint8_t r, uint8_t g, uint8_t b, uint8_t a=0xFF)
Create a new colour.
Definition gfx_type.h:223
uint32_t data
Conversion of the channel information to a 32 bit number.
Definition gfx_type.h:211
uint8_t a
colour channels in LE order
Definition gfx_type.h:213
constexpr ColourBGRA(uint data=0)
Create a new colour.
Definition gfx_type.h:229
Packed colour union to access the alpha, red, green, and blue channels from a 32 bit number for Emscr...
Definition gfx_type.h:164
uint8_t a
colour channels as used in browsers
Definition gfx_type.h:167
uint32_t data
Conversion of the channel information to a 32 bit number.
Definition gfx_type.h:165
constexpr ColourRGBA(uint8_t r, uint8_t g, uint8_t b, uint8_t a=0xFF)
Create a new colour.
Definition gfx_type.h:177
constexpr ColourRGBA(uint data=0)
Create a new colour.
Definition gfx_type.h:183
Types related to zooming in and out.
ZoomLevel
All zoom levels we know.
Definition zoom_type.h:16